diff --git a/README.md b/README.md index e699005eec05d76aaf264d0c9303c59b34a9ee11..a10ac1303808599db5670b059bf3262bbd1e43fa 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,78 @@ # Prise de rendez-vous -Créé pour faciliter la gestion des rendez-vous des collectivités territoriales, cet outil permet aux citoyens la prise en ligne de rendez-vous et aux agents en charge de les gérer en backoffice. Plug-in Drupal +Plug-in Drupal créé pour faciliter la gestion des rendez-vous des collectivités territoriales, cet outil permet aux citoyens la prise en ligne de rendez-vous et aux agents en charge de les gérer en backoffice. -## Getting started +## Financement -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +Ce projet a été rendu possible grâce au soutien de : -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +* La Préfecture de la Région Bourgogne-Franche-Comté +* La Région Bourgogne-Franche-Comté +* L'Agence Régionale du Numérique et de l'intelligence artificielle (ARNia) +* La ville d'Auxonne -## Add your files +## BackOffice -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +Les principales caractéristiques du BackOffice sont : -``` -cd existing_repo -git remote add origin https://gitlab.adullact.net/gip-arnia-bfc/prise-de-rendez-vous.git -git branch -M main -git push -uf origin main -``` +* Gestion de rendez-vous +* Agenda type Calendar +* Configuration et gestion des types de rendez-vous, des agents, des guichets et des disponibilités / indisponibilités +* Configuration et gestion de l’API SMS permettant de faire rappels des rendez-vous. -## Integrate with your tools +**N.B. :** L’envoi de SMS nécessite d’un abonnement chez un fournisseur de SMS. -- [ ] [Set up project integrations](https://gitlab.adullact.net/gip-arnia-bfc/prise-de-rendez-vous/-/settings/integrations) -## Collaborate with your team +## FrontOffice -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +Les principales caractéristiques du FrontOffice sont : -## Test and Deploy +* Interfaces adaptées aux terminaux mobiles +* Intégration automatique au site Internet dès activation du plug-in +* Emplacement pour l’affichage d’informations réglementaires (CNI, RGPD, …) +* Affichage et sélection des créneaux disponibles +* Envoi d’email de confirmation et de rappel SMS -Use the built-in continuous integration in GitLab. -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +## Déploiement de l’outil de prise de rendez-vous -*** +L’outil de prise de rendez-vous est un module Drupal. Une fois son installation réalisée par l’administrateur Drupal, la configuration nécessaire à son bon fonctionnement est mise en place. -# Editing this README +Dans la partie Back Office, un nouvel onglet apparaît dans le tableau de bord, où il est possible d’effectuer toute la gestion du module. -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +Dans la partie Front Office, un lien est généré, pour pouvoir accéder au module. Le lien existe, cependant, certaines actions sont nécessaires pour que ce lien apparaisse dans votre site web. L’objectif de ce document est de décrire ces actions. Il existe 2 possibilités : soit vous êtes rattachés à CMonSite, soit vous ne l’êtes pas. -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +Prérequis : Le module est installé dans Drupal. L’utilisateur est un webmaster, ayant accès au back office Drupal pour la création de contenus. -## Name -Choose a self-explaining name for your project. +Si vous n’êtes pas rattachés à CMonSite, le frontOffice du module sera directement accessible à l’URL : [votre site]/rendez-vous +Vous pouvez suivre les étapes suivantes pour créer un lien vers cette url. -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +Si vous êtes rattachés à CMonSite : -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +1. Entrer dans le lien [url de votre site]/rendez-vous. Vous devez voir la page du choix de type de rendez-vous. Si ce n’est pas le cas, cela signifie que le module est mal installé. Approchez-vous de l’administrateur de votre site pour l’installer. +2. Entrer dans le Back Office, puis dans le menu « Menus » -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. + -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +3. Entrer dans le menu « Navigation principale » + -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +4. Entrer dans « Ajouter un lien » + -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +5. Remplissez les informations. Dans le champ « Lien », vous devez entrer « /rendez-vous ». Pour le reste, vous pouvez configurer le nouveau menu comme vous le souhaitez. + -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +Une fois le nouveau lien enregistré et déployé sur votre site, vous pourrez accéder depuis le site à la page de prise de rendez-vous. -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +## Calendrier -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +Le calendrier de l'outil utilise la version gratuite mise à disposition des organisations à but non lucratif de la librarie DHTMLX Calendar https://dhtmlx.com/docs/products/dhtmlxCalendar/ -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +## Notice technique -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License +## Licence For open source projects, say how it is licensed. ## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Projet en cours de déploiement chez l'ARNia. diff --git a/image-1.png b/image-1.png new file mode 100644 index 0000000000000000000000000000000000000000..11509dc1c9d69505a6604ffa22141c8bb1dde698 Binary files /dev/null and b/image-1.png differ diff --git a/image-2.png b/image-2.png new file mode 100644 index 0000000000000000000000000000000000000000..35aab87a911477488a6d7b98b5b78b86324735cb Binary files /dev/null and b/image-2.png differ diff --git a/image-3.png b/image-3.png new file mode 100644 index 0000000000000000000000000000000000000000..87b70cfed42e8682f5d5afe8907965ef7017ad32 Binary files /dev/null and b/image-3.png differ diff --git a/image.png b/image.png new file mode 100644 index 0000000000000000000000000000000000000000..780665925a5b30ee21944f96e46f2c7570c73a2f Binary files /dev/null and b/image.png differ