Forked from https://github.com/GRA0007/crab.fit
translation completed updated for the source file '/crabfit-frontend/public/i18n/en/help.json' on the 'fr_FR' language. |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| crabfit-backend | ||
| crabfit-browser-extension | ||
| crabfit-frontend | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
Crab Fit 
Align your schedules to find the perfect time that works for everyone. Licensed under the GNU GPLv3.
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
- Clone the repo.
- Run
yarnin both backend and frontend folders. - Run
node index.jsin the backend folder to start the API. Note: you will need a google cloud app set up with datastore enabled and set yourGOOGLE_APPLICATION_CREDENTIALSenvironment variable to your service key path. - Run
yarn startin the frontend folder to start the front end.
🔌 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
- In the frontend folder
cd crabfit-frontend - Run
./deploy.shto compile and deploy.
⚙️ Backend
- In the backend folder
cd crabfit-backend - Deploy the backend
gcloud app deploy --project=crabfit --version=v1 - 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.