1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/crabfit_ynh.git synced 2024-09-03 18:16:21 +02:00
crabfit_ynh/README.md
2024-04-30 07:52:04 +00:00

58 lines
2.2 KiB
Markdown

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->
# Crab Fit for YunoHost
[![Integration level](https://dash.yunohost.org/integration/crabfit.svg)](https://dash.yunohost.org/appci/app/crabfit) ![Working status](https://ci-apps.yunohost.org/ci/badges/crabfit.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/crabfit.maintain.svg)
[![Install Crab Fit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=crabfit)
*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install Crab Fit quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
Crab Fit helps you fit your event around everyone's schedules.
Simply create an event above and send the link to everyone that is participating.
Results update live and you will be able to see a heat-map of when everyone is free.
## Features
- Click and slide to select multiple time slots at once.
- Editable using a one-time password
**Shipped version:** 1.0~ynh3
**Demo:** <https://crab.fit>
## Screenshots
![Screenshot of Crab Fit](./doc/screenshots/main.png)
## Documentation and resources
- Official app website: <https://crab.fit>
- Official user documentation: <https://github.com/GRA0007/crab.fit>
- Official admin documentation: <https://github.com/GRA0007/crab.fit>
- Upstream app code repository: <https://github.com/GRA0007/crab.fit>
- YunoHost Store: <https://apps.yunohost.org/app/crabfit>
- Report a bug: <https://github.com/YunoHost-Apps/crabfit_ynh/issues>
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
or
sudo yunohost app upgrade crabfit -u https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>