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

59 lines
2.2 KiB
Markdown
Raw Normal View History

2023-08-17 21:45:58 +02:00
<!--
2024-04-01 22:07:23 +02:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2023-08-17 21:45:58 +02:00
It shall NOT be edited by hand.
-->
2024-04-01 22:07:23 +02:00
# Crab Fit for YunoHost
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
[![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)
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
[![Install Crab Fit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=crabfit)
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
*[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.*
2023-08-17 21:45:58 +02:00
## Overview
2024-04-01 22:07:23 +02:00
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.
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
## Features
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
- Click and slide to select multiple time slots at once.
- Editable using a one-time password
2023-08-17 21:45:58 +02:00
2024-04-30 09:52:04 +02:00
**Shipped version:** 1.0~ynh3
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
**Demo:** <https://crab.fit>
2023-08-17 21:45:58 +02:00
## Screenshots
2024-04-01 22:07:23 +02:00
![Screenshot of Crab Fit](./doc/screenshots/main.png)
2023-08-17 21:45:58 +02:00
## Documentation and resources
2024-04-01 22:07:23 +02:00
- 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>
2023-08-17 21:45:58 +02:00
## Developer info
2024-04-01 22:07:23 +02:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing).
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
To try the `testing` branch, please proceed like that:
2023-08-17 21:45:58 +02:00
2024-04-01 22:07:23 +02:00
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
2023-08-17 21:45:58 +02:00
or
2024-04-01 22:07:23 +02:00
sudo yunohost app upgrade crabfit -u https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
2023-08-17 21:45:58 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>