scott/crabfit
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
crabfit/README.md
Ben Grant 3ca967f667 Add contribution information
2021-06-04 14:08:45 +10:00

1.9 KiB
Raw Blame History

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.
  2. Run yarn in both backend and frontend folders.
  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

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.

⚙️ Backend

  1. In the backend folder cd crabfit-backend
  2. Deploy the backend gcloud app deploy --project=crabfit --version=v1

🔌 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.