Version initiale de documentation pour l'installation
1
.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
/.idea/
|
90
README.md
|
@ -1,92 +1,2 @@
|
|||
# fabriquedoc-documentation
|
||||
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
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)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [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:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.jevalide.ca/gitlab/fabriquedoc/fabriquedoc-documentation.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://git.jevalide.ca/gitlab/fabriquedoc/fabriquedoc-documentation/-/settings/integrations)
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [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)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
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)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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.
|
||||
|
|
BIN
executer-frontend.jpg
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
git-clone-1.jpg
Normal file
After Width: | Height: | Size: 72 KiB |
BIN
git-clone-2.jpg
Normal file
After Width: | Height: | Size: 62 KiB |
BIN
git-clone-3.jpg
Normal file
After Width: | Height: | Size: 30 KiB |
126
install-windows.md
Normal file
|
@ -0,0 +1,126 @@
|
|||
## Utilisation avec Docker Desktop
|
||||
|
||||
### (Windows seulement) Installer Windows Subsystem for Linux
|
||||
|
||||
- Ouvrir un invite de commandes en tant qu'administrateur
|
||||
|
||||
![invite-commandes-administrateur.jpg](invite-commandes-administrateur.jpg)
|
||||
|
||||
Exécute cette commandes avec l'invite de commandes
|
||||
|
||||
- `wsl.exe --update`
|
||||
|
||||
### Installer Docker Desktop
|
||||
|
||||
- Télécharger depuis le site web officiel: https://www.docker.com/products/docker-desktop/
|
||||
- Installer avec le fichier téléchargé
|
||||
- Redémarrer l'ordinateur
|
||||
|
||||
### Installer Visual Studio
|
||||
|
||||
- Télécharger depuis le site officiel: https://code.visualstudio.com/
|
||||
- Installer avec le fichier téléchargé
|
||||
- Ouvrir l'application
|
||||
- Installer l'extension docker
|
||||
|
||||
![installation de docker dans vscode.jpg](installation%20de%20docker%20dans%20vscode.jpg)
|
||||
|
||||
### (Windows seulement) Installer Git for Windows
|
||||
|
||||
Clique sur l'icone de gestion de code dans Visual Studio Code.
|
||||
|
||||
Ça ressemble à trois cercles qui forment un embranchement
|
||||
|
||||
Clique ensuite sur Download Git for Windows
|
||||
|
||||
![installer git pour windows.jpg](installer%20git%20pour%20windows.jpg)
|
||||
|
||||
Clique sur Click here to download
|
||||
|
||||
![installer git pour windows -2.jpg](installer%20git%20pour%20windows%20-2.jpg)
|
||||
|
||||
Choisis les options par défaut, sauf pour ces captures:
|
||||
|
||||
- Select components: Coche (New!) Add a Git Bash Profile to Windows Terminal
|
||||
|
||||
![installer git pour windows -3.jpg](installer%20git%20pour%20windows%20-3.jpg)
|
||||
|
||||
Comme éditeur par défaut, choisis Visual Studio Code
|
||||
|
||||
![installer git pour windows -4.jpg](installer%20git%20pour%20windows%20-4.jpg)
|
||||
|
||||
Choisis l'option Override the default branch for new repositories
|
||||
|
||||
![installer git pour windows -5.jpg](installer%20git%20pour%20windows%20-5.jpg)
|
||||
|
||||
Enfin, lorsque l'installation est terminée, reviens dans Visual Studio code et clique sur Reload
|
||||
|
||||
![installer git pour windows -6.jpg](installer%20git%20pour%20windows%20-6.jpg)
|
||||
|
||||
### (Mac seulement) Installer Homebrew et git
|
||||
|
||||
- Il faudra d’abord installer Homebrew si tu ne l’as pas déjà. C’est un outil en ligne de commande qui permet d’installer une tonne de logiciels facilement.
|
||||
- Pour voir si tu l'as, Ouvre l’application Terminal depuis Launchpad puis tape `brew`
|
||||
|
||||
#### Installer homebrew
|
||||
|
||||
- Visite le site https://brew.sh et copie la ligne de code affichée au centre de la page.
|
||||
- Ouvre l’application Terminal depuis Launchpad et colle la ligne de code dedans, puis fais Entrée. Ça va te demander ton mot de passe, car Homebrew a besoin des accès avancés appelés "sudo".
|
||||
- **Attention**: Si tu n'as jamais utilisé le Terminal, tu vas probablement remarquer de quoi d'étrange. Quand tu vas taper ton mot de passe, tu ne le verras pas. Mais ça écrit pareil. C'est une pratique de sécurité courante sur les systèmes de type Unix, dont mac OS et Linux font partie. Fais juste Entrée une fois que tu as terminé.
|
||||
- Suis les instructions et Homebrew devrait s’installer sans problème.
|
||||
|
||||
Ensuite, install git avec la ligne suivante dans le terminal: `brew install git`
|
||||
|
||||
### Accéder au GitLab
|
||||
|
||||
Je vais avoir créé un accès pour GitLab avec ton courriel.
|
||||
Tu peux te connecter à GitLab pour voir les projets: https://git.jevalide.ca/gitlab/fabriquedoc/
|
||||
|
||||
Dans chaque projet, tu as le lien pour cloner le projet. Tu dois prendre le lien HTTPS.
|
||||
|
||||
![git-clone-3.jpg](git-clone-3.jpg)
|
||||
|
||||
### Backend
|
||||
|
||||
- Pour cloner dans Visual Studio Code:
|
||||
- Clone Repository et entrer cette adresse en haut: https://git.jevalide.ca/gitlab/fabriquedoc/fabriquedoc.git
|
||||
|
||||
![git-clone-1.jpg](git-clone-1.jpg)
|
||||
|
||||
Ensuite crée un nouveau dossier pour faire les tests. Tu vas cloner deux projets dedans.
|
||||
|
||||
![git-clone-2.jpg](git-clone-2.jpg)
|
||||
|
||||
- Ensuite entre utilisateur et mot de passe de GitLab pour compléter le clone.
|
||||
|
||||
- Ouvrir un terminal (dans le menu de Visual Studio Code) et exécuter `docker build -t local/fabriquedoc .` (le point est important)
|
||||
- cette partie-là est longue à compléter (6-7 minutes sur un bon ordi)
|
||||
|
||||
#### Réseau
|
||||
|
||||
- Créer un réseau virtual dans docker: `docker network create fabriquedoc`
|
||||
|
||||
#### Démarrer le backend
|
||||
|
||||
- Exécuter cette commande dans le même terminal
|
||||
`docker run -p 8000:8000 --name fabriquedoc --network fabriquedoc local/fabriquedoc`
|
||||
|
||||
### Frontend
|
||||
|
||||
Ouvre une nouvelle fenêtre de Visual Studio depuis la barre des tâches.
|
||||
|
||||
![ouvrir-second-vscode.jpg](ouvrir-second-vscode.jpg)
|
||||
|
||||
- Pour cloner dans Visual Studio Code:
|
||||
- Clone Repository et entrer cette adresse en haut: https://git.jevalide.ca/gitlab/fabriquedoc/fabriquedoc-frontend.git
|
||||
- Ensuite entrer utilisateur et mot de passe de GitLab
|
||||
- Ouvrir un terminal et exécuter `docker build -t local/fabriquedoc-frontend .` (le point est important)
|
||||
|
||||
#### Démarrer le frontend
|
||||
|
||||
- Exécuter cette commande
|
||||
`docker run -p 8051:8051 --env "FABRIQUEDOC_ENDPOINT=http://fabriquedoc:8000" --name fabriquedoc-frontend --network fabriquedoc local/fabriquedoc-frontend`
|
||||
|
||||
![executer-frontend.jpg](executer-frontend.jpg)
|
||||
|
||||
L'appli est disponible au <http://localhost:8051/>
|
BIN
installation de docker dans vscode.jpg
Normal file
After Width: | Height: | Size: 146 KiB |
BIN
installer git pour windows -2.jpg
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
installer git pour windows -3.jpg
Normal file
After Width: | Height: | Size: 46 KiB |
BIN
installer git pour windows -4.jpg
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
installer git pour windows -5.jpg
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
installer git pour windows -6.jpg
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
installer git pour windows.jpg
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
invite-commandes-administrateur.jpg
Normal file
After Width: | Height: | Size: 72 KiB |
BIN
ouvrir-second-vscode.jpg
Normal file
After Width: | Height: | Size: 29 KiB |