Skip to content

Commit dbe96d0

Browse files
[HER-112] Update readme file (#73)
* [HER-112]Update Readme file * [HER-112]Follow-up Fix typo
1 parent aeda987 commit dbe96d0

1 file changed

Lines changed: 28 additions & 12 deletions

File tree

Readme.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,36 @@ Hermes is an application for cameras that can be used for detecting recyclable m
1111
* Python
1212

1313
### Available Scripts
14-
In the project directory, you can run:
15-
### `python3 scripts/docker.run.dependencies.py`
16-
The script starts the hermes-db dependency by using docker-compose.
14+
#### In the project directory, you can run:
15+
* python3 scripts/docker.run.dependencies.py
16+
#### This script starts the hermes-db dependency by using docker-compose.
1717

1818
### Migrations Scripts
19-
In the project directory run:
20-
### `python3 scripts/migration.add.py --name Migration_Name`
21-
The script will create a new migration.
19+
#### In the project directory run:
20+
* python3 scripts/migration.add.py --name Migration_Name
2221

23-
### `python3 scripts/migration.remove.py`
24-
The script will remove the last migration created. If migration was already applied to database you have to update first to the previous migration and then remove it.
22+
#### This script will create a new migration.
2523

26-
### `python3 scripts/migration.undo.py --name Migration_Name`
27-
The script will update database to the Migration_Name
24+
* python3 scripts/migration.remove.py
2825

29-
### `python3 scripts/migration.apply.py`
30-
The script will apply the last migration created.
26+
#### This script will remove the last migration created. If a migration was already applied to the database you have to first update it to the previous migration and then remove it.
27+
28+
* python3 scripts/migration.undo.py --name Migration_Name
29+
30+
#### This script will update the database to the Migration_Name
31+
32+
* python3 scripts/migration.apply.py
33+
34+
#### This script will apply the last migration created.
35+
36+
### Abbreviations used:
37+
* *M*
38+
* **M** comes from **Model** and it is used in **Business Layer**.
39+
* *P*
40+
* **P** comes from **Parameter** and it is a **Parameter Model** used in **Business Layer**.
41+
* *E*
42+
* **E** comes from **Entity** and it is used in **Data Layer**.
43+
* *T*
44+
* **T** comes from **Type** and it is a **Graphql type** used in **Presentation Layer**.
45+
* *TP*
46+
* **TP** comes from **Type Parameter** and it is a **Graphql type parameter** used in **Presentation Layer**.

0 commit comments

Comments
 (0)