diff --git a/README.md b/README.md index 34742d7..125367b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ -# Crabfit avatar +# Crab Fit avatar Align your schedules to find the perfect time that works for everyone. Licensed under the GNU GPLv3. Crab Fit - Use your availability to find a time that works for everyone | Product Hunt +## Contributing + +### ⭐️ Bugs or feature requests + +If you find any bugs or have a feature request, please create an issue by clicking here. + +### 🌐 Translations + +If you speak a language other than English and you want to help translate Crab Fit, fill out this form: https://forms.gle/azz1yGqhpLUka45S9 + ## Setup 1. Clone the repo. @@ -12,18 +22,18 @@ Licensed under the GNU GPLv3. 3. Run `node index.js` in the backend folder to start the API. 4. Run `yarn start` in the frontend folder to start the front end. -### Browser extension +### 🔌 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 +### 🦀 Frontend 1. In the frontend folder `cd crabfit-frontend` 2. Run `./deploy.sh` to compile and deploy. -### Backend +### ⚙️ Backend 1. In the backend folder `cd crabfit-backend` 2. Deploy the backend `gcloud app deploy --project=crabfit --version=v1` -### Browser extension +### 🔌 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.