1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grr_ynh.git synced 2024-09-03 19:15:56 +02:00
grr_ynh/README.md

77 lines
4.3 KiB
Markdown
Raw Normal View History

2021-10-26 12:00:04 +02:00
<!--
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.
-->
2021-10-28 16:31:34 +02:00
# Grr for YunoHost
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
[![Integration level](https://dash.yunohost.org/integration/grr.svg)](https://dash.yunohost.org/appci/app/grr) ![](https://ci-apps.yunohost.org/ci/badges/grr.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grr.maintain.svg)
[![Install Grr with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grr)
2021-10-26 12:00:04 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-10-28 16:31:34 +02:00
> *This package allows you to install Grr quickly and simply on a YunoHost server.
2021-10-26 12:00:04 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-10-28 16:31:34 +02:00
GRR is a resource reservation management system (rooms, equipment, vehicle, staff) but it can also be used as a shared mini-diary. Developed in php and responsive, which allows it to be accessible, from anywhere and on any type of equipment (PC, Mac, tablet, phone, TV ...).
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
GRR is fully configurable (management of schedules, access, emails ...) and remains easy to use.
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
### Features
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
- Access to the shared management tool via any web browser,
- The administration of several types of shared resources (rooms, cars, equipment, etc.),
- The management of reservations for these resources (creation, modification, deletion),
- Management of the type of access to a resource; access restricted to certain users or not,
- The possibility of making periodic reservations,
- The possibility of configuring a calendar of "public holidays", inaccessible to reservations,
- The possibility of making reservations "subject to", to be confirmed before a fixed date,
- The possibility of making reservations "in moderation",
- The possibility of making reservations on behalf of other users or external persons
- The possibility of defining, domain by domain, additional fields,
- The possibility of defining "cycle days" (see documentation),
- Fine management of sending automatic emails,
- The delegation to users of the administration of certain domains,
- Delegation to users of the management of reservations for certain resources,
- The possibility for a manager to display a reservation as "in use",
- The possibility of temporarily making a resource unavailable for maintenance for example,
- The ability to configure a presentation sheet with an image for each resource,
- The visualization of the planning of resource reservations in different forms,
- The possibility of configuring the type of access to the application (obligation or not to connect to access the site),
- The possibility of customizing by domain the display parameters of the reservation schedule (start and end times of the day, smallest bookable block, ... or pre-defined time slots).
- The possibility of setting, for each resource, a maximum number of days beyond which the user cannot reserve or modify an existing reservation.
- The possibility of setting, for each resource, a time, below which the user cannot reserve or modify an existing reservation.
- The possibility of reserving or freeing very quickly whole days simultaneously on several resources of several domains and according to a calendar.
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
**Shipped version:** 3.4.2b~ynh1
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
## Screenshots
2021-10-26 12:00:04 +02:00
2021-10-28 16:31:34 +02:00
![](./doc/screenshots/home.png)
2021-10-26 12:00:04 +02:00
## Documentation and resources
2021-10-28 16:31:34 +02:00
* Official app website: https://site.devome.com/fr/grr3
* Official user documentation: https://site.devome.com/fr/grr/telechargement/category/2-informations-documentations
* Official admin documentation: https://site.devome.com/fr/grr/telechargement/category/2-informations-documentations
* Upstream app code repository: https://github.com/JeromeDevome/GRR
* YunoHost documentation for this app: https://yunohost.org/app_grr
* Report a bug: https://github.com/YunoHost-Apps/grr_ynh/issues
2021-10-26 12:00:04 +02:00
## Developer info
2021-10-28 16:31:34 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grr_ynh/tree/testing).
2021-10-26 12:00:04 +02:00
To try the testing branch, please proceed like that.
```
2021-10-28 16:31:34 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/grr_ynh/tree/testing --debug
2021-10-26 12:00:04 +02:00
or
2021-10-28 16:31:34 +02:00
sudo yunohost app upgrade grr -u https://github.com/YunoHost-Apps/grr_ynh/tree/testing --debug
2021-10-26 12:00:04 +02:00
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps