diff --git a/Bug_et_problemes.md b/Bug_et_problemes.md new file mode 100644 index 0000000000000000000000000000000000000000..dd4a0994d1eaef4fbda2f4f0f663df5b37064944 --- /dev/null +++ b/Bug_et_problemes.md @@ -0,0 +1,7 @@ +- interface web pas responsive +- clignotement du "back to home" +- joueur parfois kick des quiz de manière random après une question (quand plusieurs ont la mm bonne réponse en mm temps on dirait) +- logo sous licence +- pas de média +- une note beaucoup trop haute pour un projet à moitié terminé +- l'interface pour rejoindre est nulle (aucun style css) diff --git a/README.md b/README.md index 35dbeea9200b55fab0bf8457e57fff5b7d6b4114..e789cefc3be16fe4e3afd6247727328c54f0b056 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,74 @@ -# Gyokeres Deploy Assistance +# Gyokeres Deploy Assistance - FAQ de Déploiement +Ce guide fournit des instructions sur comment déployer et exécuter les différents composants du projet Gyokeres. +## API -## Getting started +### Comment déployer -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +1. Exécutez le script d'initialisation : + ```bash + ./init.sh + ``` -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)! +### Notes -## Add your files +- Relancer `init.sh` réinitialisera les données des conteneurs (y compris la base de données) +- Pour la persistance des données, envisagez de monter un volume Docker +- PgAdmin est disponible mais nécessite une configuration supplémentaire pour se connecter aux bases de données -- [ ] [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: +## Application Mobile -``` -cd existing_repo -git remote add origin https://git.unistra.fr/jagermasters/gyokeres-deploy-assistance.git -git branch -M main -git push -uf origin main -``` +### Comment déployer -## Integrate with your tools +1. Installez les dépendances : -- [ ] [Set up project integrations](https://git.unistra.fr/jagermasters/gyokeres-deploy-assistance/-/settings/integrations) + ```bash + npm install + ``` -## Collaborate with your team +2. Démarrez le serveur de développement : + ```bash + npm run start + ``` -- [ ] [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/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +### Compilation pour Android en local -## Test and Deploy +1. Suivez les instructions à : https://www.youtube.com/watch?v=4TjRX90XpEM +2. Compilez en utilisant : + ```bash + eas build --android --local + ``` -Use the built-in continuous integration in GitLab. +## Application Web -- [ ] [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) +### Comment déployer -*** +1. Exécutez le script d'initialisation : -# Editing this README + ```bash + ./init.sh + ``` -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!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +2. Accédez à l'application à : + ``` + http://localhost:8080/home + ``` -## Suggestions for a good README +## Recommandations de Déploiement -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. +- **Documentation** : Envisagez d'étoffer la documentation avec des instructions d'installation +- **Configuration Docker** : Envisagez de placer la logique de déploiement dans des Dockerfiles pour : + - Faciliter le redémarrage en cas d'erreurs + - Améliorer la portabilité + - Améliorer la synchronisation et la persistance des données +- **Structure du dépôt** : Actuellement maintenu comme des dépôts séparés suivant la structure originale -## Name -Choose a self-explaining name for your project. +## Configuration du Serveur -## 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. +Pour préparer un serveur Proxmox : -## 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. connexion au vpn, puis `ssh sae61-jager@130.79.214.170` ou (root) `ssh sae61-jagermasters@130.79.214.170` +1. (éventuel) ajouter l'user de base aux sudoers `sudo usermod -aG sudo sae61-jager` +1. Installez Docker (commandes à ajouter) <https://docs.docker.com/engine/install/debian/#install-using-the-repository> -## 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. - -## 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. - -## 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. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -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. - -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. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -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. diff --git a/S6_consignes.md b/S6_consignes.md new file mode 100644 index 0000000000000000000000000000000000000000..b07886abd58238da4a8f04885eb5afc02f83adae --- /dev/null +++ b/S6_consignes.md @@ -0,0 +1,17 @@ +1 rendu +- Rapport (FAQ) de comment on a lancer et les prb +- Notre propre doc de deploiement (on peut corriger, modif) +- Obligation d'utiliser proxmox +- Faut rendre un git propre + +2em rendu +- rapport de test +- corrections + +3em rendu +- nous balance des ptn d'issues sur gitlab ET faut tout traiter +- et une feature à ajouter (qui modifie un peu tout, donc faut comprendre généralement le projet) + +Avec Schott elliot => Gyokereske + +