From dff287c9f302524391a6064424e67587f01ce200 Mon Sep 17 00:00:00 2001 From: Sandino Scheidegger Date: Thu, 16 Nov 2023 10:55:34 +0100 Subject: [PATCH 1/2] Added information for error handling for better guidance. --- README.md | 42 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d712fb0e8..8efc2115c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -94,9 +90,43 @@ npm install Once the dependencies are installed, you can start the different environments: -- First, start the Firebase emulator with `npm run firebase:serve` — +### Step 1 ### +Start the Firebase emulator with `npm run firebase:serve` — console dashboard is available at [localhost:4000](http://localhost:4000). + +
+Troubleshooting Errors + +#### 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) + +
+ +### 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 From 077ad67f6d7aa22944c34bd9a6cbb01e7259fb24 Mon Sep 17 00:00:00 2001 From: ssandino Date: Thu, 16 Nov 2023 10:01:08 +0000 Subject: [PATCH 2/2] Prettified Code! --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8efc2115c..65d61a551 100644 --- a/README.md +++ b/README.md @@ -90,10 +90,10 @@ npm install Once the dependencies are installed, you can start the different environments: -### Step 1 ### -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).
Troubleshooting Errors @@ -101,32 +101,38 @@ Start the Firebase emulator with `npm run firebase:serve` — #### 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 +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)). +> 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)
-### Step 2 ### +### 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