From 4c1190d4045693d851933a159e723f9a337bf10f Mon Sep 17 00:00:00 2001 From: Ben Grant Date: Sat, 20 Aug 2022 22:01:45 +1000 Subject: [PATCH] Update deployment documentation --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e23e460..1b44745 100644 --- a/README.md +++ b/README.md @@ -19,22 +19,19 @@ If you speak a language other than English and you want to help translate Crab F 1. Clone the repo. 2. Run `yarn` in both backend and frontend folders. -3. Run `node index.js` in the backend folder to start the API. **Note:** you will need a google cloud app set up with datastore enabled and set your `GOOGLE_APPLICATION_CREDENTIALS` environment variable to your service key path. -4. Run `yarn start` in the frontend folder to start the front end. +3. Run `yarn dev` in the backend folder to start the API. **Note:** you will need a google cloud app set up with datastore enabled and set your `GOOGLE_APPLICATION_CREDENTIALS` environment variable to your service key path. +4. Run `yarn dev` in the frontend folder to start the frontend. ### 🔌 Browser extension + The browser extension in `crabfit-browser-extension` can be tested by first running the frontend, and changing the iframe url in the extension's `popup.html` to match the local Crab Fit. Then it can be loaded as an unpacked extension in Chrome to test. ## Deploy -### 🦀 Frontend -1. In the frontend folder `cd crabfit-frontend` -2. Run `./deploy.sh` to compile and deploy. +Deployments are managed with GitHub Workflows. -### ⚙️ Backend -1. In the backend folder `cd crabfit-backend` -2. Deploy the backend `gcloud app deploy --project=crabfit --version=v1` -3. To deploy cron jobs (i.e. monthly cleanup of old events), run `gcloud app deploy cron.yaml` +To deploy cron jobs (i.e. monthly cleanup of old events), run `gcloud app deploy cron.yaml`. ### 🔌 Browser extension + Compress everything inside the `crabfit-browser-extension` folder and use that zip to deploy using Chrome web store and Mozilla Add-on store.