Skip to content

Commit 245a511

Browse files
committed
feat: update functions README
1 parent 03fb632 commit 245a511

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

functions/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,20 @@ Getting Started
2626
- You should be getting the result of the addition.
2727
11. Write a message in the Box below and Click the "Add Message" button.
2828
- The message is added below but if it contains [bad words](https://github.com/web-mech/badwords-list) or SHOUTING!! it will be sanitized.
29-
29+
30+
To run the sample app locally during development:
31+
1. Run `npm install` to install dependencies.
32+
2. Run `npm --prefix functions run build` to build the functions using Vite.
33+
3. Run `firebase emulators:start` to start the local Firebase emulators.
34+
4. Run `npm run dev` to serve the app locally using Vite
35+
This will start a server locally that serves `index.html` on `http://localhost:5173/index.html`.
36+
37+
Running the app using the Firebase CLI:
38+
1. Run `npm install` to install dependencies.
39+
2. Run `npm run build` to build the app using Vite.
40+
3. Run `firebase emulators:start` to start the local Firebase emulators.
41+
4. In your terminal output, you will see the "Hosting" URL. By default, it will be `127.0.0.1:5002`, though it may be different for you.
42+
5. Navigate in your browser to the URL output by the `firebase emulators:start` command.
3043

3144
Support
3245
-------

0 commit comments

Comments
 (0)