crabfit/README.md
2023-06-11 15:10:24 +10:00

30 lines
1.4 KiB
Markdown

# Crab Fit <img width="100" align="right" src="frontend/src/res/logo.svg" alt="avatar">
[![Frontend Checks](https://github.com/GRA0007/crab.fit/actions/workflows/check_frontend.yml/badge.svg)](https://github.com/GRA0007/crab.fit/actions/workflows/check_frontend.yml)
[![API Checks](https://github.com/GRA0007/crab.fit/actions/workflows/check_api.yml/badge.svg)](https://github.com/GRA0007/crab.fit/actions/workflows/check_api.yml)
Align your schedules to find the perfect time that works for everyone.
Open-source and licensed under the [GNU GPLv3](./LICENSE).
### ⭐️ Bugs or feature requests
If you find any bugs or have a feature request, please [create an issue](https://github.com/GRA0007/crab.fit/issues/new/choose).
### 🌐 Translations
https://explore.transifex.com/crab-fit/crab-fit/
If you speak a language other than English and you want to help translate Crab Fit, visit Transifex using the link above and click "Join this project".
For more information on how to translate, visit the [translating wiki page](https://github.com/GRA0007/crab.fit/wiki/Translating).
---
### Self-hosting
Crab Fit is fully open-source, and you can get your own version running by following the [self-hosting guide](https://github.com/GRA0007/crab.fit/wiki/Self%E2%80%90hosting).
### Contributing
Visit the [contributing guide](./CONTRIBUTING.md) for info on running locally and submitting pull requests.