easyappointments_ynh/README.md

62 lines
2.8 KiB
Markdown
Raw Normal View History

2021-08-14 19:18:52 +03:00
<!--
2024-03-29 09:01:07 +03:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2021-08-14 19:18:52 +03:00
It shall NOT be edited by hand.
-->
2021-08-13 20:43:05 +03:00
# Easy!Appointments for YunoHost
2021-08-13 15:48:24 +03:00
2023-03-29 20:23:53 +03:00
[![Integration level](https://dash.yunohost.org/integration/easyappointments.svg)](https://dash.yunohost.org/appci/app/easyappointments) ![Working status](https://ci-apps.yunohost.org/ci/badges/easyappointments.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/easyappointments.maintain.svg)
2021-08-13 23:22:43 +03:00
[![Install Easy!Appointments with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=easyappointments)
2021-08-13 15:48:24 +03:00
2024-06-23 14:30:20 +03:00
*[Read this README in other languages.](./ALL_README.md)*
2021-08-13 15:48:24 +03:00
2024-03-29 09:01:07 +03:00
> *This package allows you to install Easy!Appointments 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.*
2021-08-13 15:48:24 +03:00
## Overview
2021-09-03 13:44:11 +03:00
Easy!Appointments is a highly customizable web application that allows customers to book appointments with you via a sophisticated web interface. Moreover, it provides the ability to sync your data with Google Calendar so you can use them with other services. It is an open source project that you can download and install even for commercial use. Easy!Appointments will run smoothly with your existing website as it can be installed in a single folder of the server and of course share an existing database.
### Features
The application is designed to be flexible enough so that it can handle any enterprise work flow.
- Customers and appointments management.
- Services and providers organization.
- Working plan and booking rules.
- Google Calendar synchronization.
- Email notifications system.
- Self hosted installation.
- Translated user interface.
2021-09-03 14:03:32 +03:00
2021-08-13 15:48:24 +03:00
2023-09-10 10:02:53 +03:00
**Shipped version:** 1.4.3~ynh3
2021-08-13 15:48:24 +03:00
2024-03-29 09:01:07 +03:00
**Demo:** <https://demo.easyappointments.org/>
2021-08-13 15:48:24 +03:00
2021-08-14 19:18:52 +03:00
## Screenshots
2021-08-13 15:48:24 +03:00
2022-06-01 05:16:25 +03:00
![Screenshot of Easy!Appointments](./doc/screenshots/screenshots.png)
2021-08-13 15:48:24 +03:00
2021-08-14 19:18:52 +03:00
## Documentation and resources
2021-08-13 15:48:24 +03:00
2024-03-29 09:01:07 +03:00
- Official app website: <https://easyappointments.org/>
- Official admin documentation: <https://easyappointments.org/docs.html#1.4.3/readme.md>
- Upstream app code repository: <https://github.com/alextselegidis/easyappointments>
- YunoHost Store: <https://apps.yunohost.org/app/easyappointments>
- Report a bug: <https://github.com/YunoHost-Apps/easyappointments_ynh/issues>
2021-08-13 15:48:24 +03:00
2021-08-14 19:18:52 +03:00
## Developer info
2021-08-13 15:48:24 +03:00
2024-03-29 09:01:07 +03:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing).
2021-08-13 15:48:24 +03:00
2024-03-29 09:01:07 +03:00
To try the `testing` branch, please proceed like that:
2022-06-01 05:16:25 +03:00
2024-03-29 09:01:07 +03:00
```bash
2021-08-13 23:22:43 +03:00
sudo yunohost app install https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing --debug
2021-08-13 15:48:24 +03:00
or
2021-08-13 23:23:49 +03:00
sudo yunohost app upgrade easyappointments -u https://github.com/YunoHost-Apps/easyappointments_ynh/tree/testing --debug
2021-08-13 15:48:24 +03:00
```
2021-08-14 19:18:52 +03:00
2022-06-01 05:16:25 +03:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>