Browse Source

docs(crud-master): add readme requirement to subject and audit

pull/2039/head
mikysett 1 year ago committed by Zouhair AMAZZAL
parent
commit
089a6eca0c
  1. 13
      subjects/devops/crud-master/README.md
  2. 6
      subjects/devops/crud-master/audit/README.md

13
subjects/devops/crud-master/README.md

@ -200,12 +200,23 @@ After entering in your VM via SSH you may run the following commands:
- `sudo pm2 stop <app_name>`: Stop a specific application.
- `sudo pm2 start <app_name>`: Start a specific application.
#### Overall file structure
#### Project organization
##### README.md
As a good exercise and an helpful tool it is required for you to deliver a `README.md` describing the project.
The idea of a `README.md` is to give in few lines enough context about a project to understand what is it about and how to run it.
This file should include instructions to run and test the project, it should also give a brief and clear overview of the stack used to build it.
##### Overall file structure
You can organize your internal file structure as you prefer. That said here is a common way to structure this kind of projects that may help you:
```console
.
├── README.md
├── config.yaml
├── .env
├── scripts

6
subjects/devops/crud-master/audit/README.md

@ -2,6 +2,12 @@
##### Before we start, let's check we have the necessary tools to perform the tests. You should make sure VirtualBox, Vagrant and Postman are installed, if not you should install them.
#### Documentation
##### Take a look at the `README.md` file provided by the student.
###### Does the file includes enough context and details to understand and run the project?
#### VM Configuration
##### In the directory of the project run `vagrant up --provider virtualbox` and then run `vagrant status`.

Loading…
Cancel
Save