Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(general): update readme #633

Merged
merged 2 commits into from
Nov 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,7 @@ Before you can start developing, you need to install the dependencies by
running. Make sure you are using Node.js 18. If you are using Homebrew,
you can install it with `brew install node@18` and follow
[this](https://ralphjsmit.com/switch-between-nodejs-versions-homebrew)
guide to switch between different versions of Node.js if need be. On
MacBook Pro (Intel) there seems to be an issue if you don't use exactly
the 18.15.0 Version:
[Download](https://nodejs.org/dist/v18.15.0/node-v18.15.0.pkg) /
[Issue](https://github.com/firebase/firebase-tools/issues/5614)
guide to switch between different versions of Node.js if need be.

```shell
npm install
Expand All @@ -94,9 +90,49 @@ npm install
Once the dependencies are installed, you can start the different
environments:

- First, start the Firebase emulator with `npm run firebase:serve` —
console dashboard is available at
[localhost:4000](http://localhost:4000).
### Step 1

Start the Firebase emulator with `npm run firebase:serve` — console
dashboard is available at [localhost:4000](http://localhost:4000).

<details>
<summary><strong>Troubleshooting Errors</strong></summary>

#### macOS Error Handling

### Issue 1:

> Error: Could not start Pub/Sub Emulator, port taken.

**Solution:**

1. Identify the Process Using Port 8085:

```
lsof -i -P -n | grep java
```

2. Terminate the Conflicting Process:

```
kill [PID]
```

### Issue 2

> Error: Fatal error occurred.

On MacBook Pro (Intel) there seems to be an issue if you don't use
exactly Node.js version 18.15.0
([Issue](https://github.com/firebase/firebase-tools/issues/5614)).

**Solution:**
[Download 18.15.02](https://nodejs.org/dist/v18.15.0/node-v18.15.0.pkg)

</details>

### Step 2

- To start the Admin Tool, run `npm run admin:serve` and open
[localhost:3000](http://localhost:3000).
- To start the Website, run `npm run website:serve` and open
Expand Down
Loading