scott/crabfit
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
Forked from https://github.com/GRA0007/crab.fit
457 commits 2 branches 0 tags 2.2 MiB
TypeScript 60.8%
Rust 23.5%
SCSS 12.2%
CSS 1.5%
Dockerfile 1.2%
Other 0.8%
Find a file
Benji Grant a46e697435 Use NPM to install vercel cli
2023-06-10 12:02:43 +10:00
.github Use NPM to install vercel cli 2023-06-10 12:02:43 +10:00
api Relax rate-limit 2023-06-09 23:20:51 +10:00
browser-extension Add docs for FRONTEND_URL env var 2023-05-16 02:42:01 +10:00
frontend Update privacy policy to include Vercel analytics 2023-06-10 00:21:24 +10:00
.gitignore Add docs for FRONTEND_URL env var 2023-05-16 02:42:01 +10:00
LICENSE Add GNU GPLv3 license 2021-05-26 18:51:18 +10:00
README.md Update readme 2023-06-10 00:27:53 +10:00

README.md

Crab Fit avatar

Frontend Checks API Checks

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

Pull requests

If you see an issue you want to fix, or want to implement a feature you think would be useful, please feel free to open a pull request with your changes. If you can, please open an issue about the bug or feature you want to work on before starting your PR, to prevent work duplication and give others a chance to improve your idea.

Setup

  1. Clone the repo and ensure you have node, yarn and rust installed on your machine.
  2. Run yarn in frontend folder to install dependencies, then yarn dev to start the dev server.
  3. Run cargo run in the api folder to start the API.

🔌 Browser extension

The browser extension in 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. The frontend is deployed using Vercel, and the API uses Fly.io.

More detailed instructions on setting up your own deployment are coming soon.

🔌 Browser extension

Compress everything inside the browser-extension folder and use that zip to deploy using Chrome web store and Mozilla Add-on store.