Better Doc

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Description
+
+Please provide a brief description of the changes made in this pull request.
+
+## Checklist
+
+- [ ] I have tested the changes locally and they work as expected.
+- [ ] I have tested the responsiveness of the changes and they work as expected.
+- [ ] I have assigned the pull request to the appropriate reviewer(s).
+- [ ] I have added labels to the pull request, if necessary.
+
+## Related Issues
+
+Please list any related issues or pull requests here.
+
+## Screenshots
+
+If applicable, add screenshots to help explain the changes made.
+

README.md

@@ -1,26 +1,22 @@
-# Contributing
+# Insalan Frontend
 
-Please read carefully[the CONTRIBUTING.md file](CONTRIBUTING.md) before any
-contribution.
+## Description
 
-# Run the frontend in local
+This is the frontend of the Insalan website. It is a Vue.js application. It is
+served by a Nginx server. It is part of the [insalan.fr](https://insalan.fr)
+infrastructure and is deployed with the
+[infra-insalan.fr](https://github.com/InsaLan/infra-insalan.fr) repository.
 
-The frontend has to be deployed from the docker-compose setup (so you need to install it!).
-Please refer to [this README](https://github.com/InsaLan/infra-insalan.fr/blob/main/README.md)
+## Contributing
 
-The front is available here: dev.insalan.localhost
+Please read carefully [the CONTRIBUTING.md file](CONTRIBUTING.md) before any
+contribution.
 
-# To Do
+## Run the frontend in local
 
-- [ ] Partenaire [PiphPaf](https://github.com/PiphPaf)
-- [ ] Tournois [Istar](https://github.com/istar410)
-- [ ] /user/me [Kwikkill](https://github.com/KwikKill)
-- [ ] Reset Password Astiqueur
-- [ ] Linting [Dyskal](https://github.com/Dyskal)
-- [ ] Erreur
-- [ ] Infos Ecnama
-- [ ] Localisation
-- [ ] Pizza (secondaire)
-- [ ] Restauration (secondaire)
-- [ ] Pimp Enregistrement (secondaire)
+The frontend has to be deployed from the docker-compose setup (so you need to
+install it!). Please refer to [this
+README](https://github.com/InsaLan/infra-insalan.fr/blob/main/README.md)
 
+Once the docker-compose is running, you can access the frontend at
+`http://beta.localhost` if you are using the default beta configuration.