Skip to content

Document common nx commands in README #2463

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.

Sign up for GitHub

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

Merged
rfontanarosa merged 2 commits into from
Mar 26, 2026
Merged

Document common nx commands in README #2463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4eb2bfb
Document common nx commands in README
rfontanarosa Mar 21, 2026
64c9a0e
Merge branch 'master' into rfontanarosa/1865/code-health-add-docs-for…
rfontanarosa Mar 26, 2026
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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,25 @@ To deploy to your own production Firebase:
### Next steps

For instructions on how to deploy to your own production Firebase project, see the [Ground Developer's Guide](https://github.com/google/ground-platform/wiki/Ground-Developer's-Guide).

## Common commands

All commands use [Nx](https://nx.dev) and [pnpm](https://pnpm.io). Run them from the repo root.

| Command | Description |
| ------- | ----------- |
| `nx start` | Build and start the local Firebase emulator and Angular dev server |
| `nx run root:build` | Build all packages |
| `nx run root:test` | Run all tests |
| `nx run root:lint` | Lint all packages |
| `nx run web:serve` | Serve the web app only (no emulator) |
| `nx run web:serve:staging` | Serve the web app against the live staging environment |
| `nx run web:test` | Run web tests |
| `nx run web:extract-i18n` | Extract i18n messages from the web app |
| `nx run functions:test` | Run Cloud Functions tests |
| `nx run functions:emulate` | Start the Firebase emulator for functions only |
| `nx run functions:logs` | Tail Cloud Functions logs |
| `nx run functions:shell` | Open an interactive Cloud Functions shell |
| `nx run root:export:local` | Save current emulator data to disk for use on next run |
| `nx run root:deploy:staging` | Build and deploy all to staging |
| `nx run root:deploy:production` | Build and deploy all to production |
Loading