Challenge view
Back to Projectcrab.fit
Enter your availability to find a time that works for everyone!
We are using crab.fit to plan our DINAcon HACKnight meetups this year. It takes an interesting approach to collect personal preference in a data-protection-conformant way, and presents an original interface to enter and visualize group preferences. Despite being a small project, we found it reliable and useful for planning the HACKnight.
Donate: PayPal
{ hacknight challenges }
What tools do you use for planning meetings for your open initiative? Learn about some of the open source alternatives. Set up a plan for your next code jam, footy match, or Jass night at https://crab.fit
Consider setting up your own crab.fit instance on a free Google Cloud trial. Let the developers know how straightforward the process is, if anything is lacking in the documentation. Become a translator or make a donation.
See the instructions below to deploy and contribute to the open source project. Check out for example issue #143 that we are already discussing with crab.fit devs.
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
yarn
in both backend and frontend folders. - 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 yourGOOGLE_APPLICATION_CREDENTIALS
environment variable to your service key path. - 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
Deployments are managed with GitHub Workflows.
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.