scott/crabfit
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add contribution information

Browse source
This commit is contained in:
Ben Grant 2021-06-04 14:08:45 +10:00
parent c58f8e1b8a
commit 3ca967f667
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,10 +1,20 @@
# Crabfit <img width="100" align="right" src="crabfit-frontend/src/res/logo.svg" alt="avatar"> # Crab Fit <img width="100" align="right" src="crabfit-frontend/src/res/logo.svg" alt="avatar">
Align your schedules to find the perfect time that works for everyone. Align your schedules to find the perfect time that works for everyone.
Licensed under the GNU GPLv3. Licensed under the GNU GPLv3.
<a href="https://www.producthunt.com/posts/crab-fit?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-crab-fit" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=291656&theme=light" alt="Crab Fit - Use your availability to find a time that works for everyone | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a> <a href="https://www.producthunt.com/posts/crab-fit?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-crab-fit" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=291656&theme=light" alt="Crab Fit - Use your availability to find a time that works for everyone | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
## Contributing
### ⭐️ Bugs or feature requests
If you find any bugs or have a feature request, please create an issue by <a href="https://github.com/GRA0007/crab.fit/issues/new/choose">clicking here</a>.
### 🌐 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 ## Setup
1. Clone the repo. 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. 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. 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. 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 ## Deploy
### Frontend ### 🦀 Frontend
1. In the frontend folder `cd crabfit-frontend` 1. In the frontend folder `cd crabfit-frontend`
2. Run `./deploy.sh` to compile and deploy. 2. Run `./deploy.sh` to compile and deploy.
### Backend ### ⚙️ Backend
1. In the backend folder `cd crabfit-backend` 1. In the backend folder `cd crabfit-backend`
2. Deploy the backend `gcloud app deploy --project=crabfit --version=v1` 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. Compress everything inside the `crabfit-browser-extension` folder and use that zip to deploy using Chrome web store and Mozilla Add-on store.