Skip to content
Draft
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .github/actions/verify-test/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ runs:

- name: Build project and local deps
shell: bash
run: npm run build-all --config=local
run: npm run build-all --config=test

- name: Copy Firebase emulator data
uses: actions/download-artifact@v4
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/check-web.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ jobs:
with:
node-version: "20"

- name: Create empty key files
run: ./precheck.sh

- name: Build and install dependencies
run: npm ci

Expand Down
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Open Source Helpers](https://www.codetriage.com/google/ground-platform/badges/users.svg)](https://www.codetriage.com/google/ground-platform)

Ground is a map-first data collection platform aiming to seamlessly connect the offline world with cloud-based storage and computation. It addresses the needs of non-technical local community members, smallholder farmers, and professionals and researchers working in the areas of climate, sustainability, and humanitarian aid. It consists of a web app for survey management, and an Android app for offline data collection backed by Firebase.
Ground is a map-first data collection platform which to seamlessly connect the offline world with cloud-based storage and computation. It addresses the needs of non-technical local community members, smallholder farmers, and professionals and researchers working in the areas of climate, sustainability, and humanitarian aid. It consists of a web app for survey management, and an Android app for offline data collection backed by Firebase.

**Note:** Ground is not an officially supported product; it is being developed and maintained on a best-effort basis.

Expand All @@ -23,28 +23,24 @@ Read through our [contributing guidelines](CONTRIBUTING.md) to learn about our s

## Quick start

### 1. Configure
First, install Node.js 20. The easiest way is to use [nvm](https://github.com/nvm-sh/nvm). To do this, after installing nvm, run `nvm install 20`.

Set up your environment by following instructions in "[first-time setup](https://github.com/google/ground-platform/wiki/Ground-Developer's-Guide#first-time-setup)" before you begin.
Ground uses [Nx](https://nx.dev) to manage the build. To install, run:

### 1. Install deps

```bash
npm install
```bash
npm install -g nx
```

### 2. Build and run locally
While we wait for the Nx Cloud GitHub app to be approved in our org, you also need to run:

Build with:

```bash
npm run build-all --config=local
```bash
export NX_NO_CLOUD=true
```

Run against a local Firebase emulator:
Finally, to build and run the Angular app and Cloud Functions in a local emulator:

```bash
npm run start:local
nx serve
```

Once the local server is ready, access the web app at [http://localhost:5000](http://localhost:5000). For development, and testing, the Firebase Emulator Suite UI is accessible at http://localhost:4000. Changes to the web app in `web/` and to Cloud Functions in `functions/` are automatically rebuilt and reloaded on save.
Expand Down
2 changes: 1 addition & 1 deletion e2e-tests/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "./node_modules/gts",
"extends": "../node_modules/gts",
"env": {
"jasmine": true
},
Expand Down
2 changes: 1 addition & 1 deletion e2e-tests/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "./node_modules/gts/tsconfig-google.json",
"extends": "../node_modules/gts/tsconfig-google.json",
"compilerOptions": {
"rootDir": ".",
"outDir": "build",
Expand Down
5 changes: 1 addition & 4 deletions firebase.local.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"indexes": "firestore/firestore.indexes.json"
},
"hosting": {
"public": "web/dist/web",
"source": "web",
"redirects": [
{
"source": "/",
Expand Down Expand Up @@ -31,9 +31,6 @@
]
},
"emulators": {
"auth": {
"port": 9099
},
"functions": {
"port": 5001
},
Expand Down
5 changes: 3 additions & 2 deletions nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,6 @@
"e2e": {
"cache": true
}
}
}
},
"nxCloudId": "694475da9738715747d07556"
}
Loading