Skip to content

Commit f0b8c88

Browse files
authored
Add web app running instructions to CONTRIBUTING.md
Added instructions for running the web app locally and connecting to Firebase Emulators.
1 parent f761a61 commit f0b8c88

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ In order to contribute, you must use the Firebase Emulator Suite.
1414

1515
Note: The mobile client connects to the Firebase Emulators in debug mode only (`kDebugMode`). You may change this in `lib/main.dart`, but do not commit your changes.
1616

17+
## Running the web app
18+
- Open the `web/` directory in any IDE you'd like.
19+
- Run `npm install` to install all the dependencies.
20+
- Run `npm run dev` to run the app locally.
21+
22+
Note: The web client connects to the Firebase Emulators in `localhost`. You may change this in `lib/firebase/firebase.ts`, but do not commit your changes. If you'd like to connect to the real Firebase project, use `https://127.0.0.1:3000` instead.
23+
24+
1725
## Pull Requests
1826
Your pull requests will be reviewed throughly, please submit many small pull requests rather than one big one.
1927
Make sure to assign proper labels to your pull request as it will impact the review.

0 commit comments

Comments
 (0)