update README.md to show commands in code blocks (#4932)
This commit is contained in:
parent
192debd829
commit
8c0a0415de
43
README.md
43
README.md
@ -128,14 +128,41 @@ For collaboration, you will need to set up [collab server](https://github.com/ex
|
|||||||
|
|
||||||
#### Commands
|
#### Commands
|
||||||
|
|
||||||
| Command | Description |
|
##### Install the dependencies
|
||||||
| ------------------ | --------------------------------- |
|
|
||||||
| `yarn` | Install the dependencies |
|
```
|
||||||
| `yarn start` | Run the project |
|
yarn
|
||||||
| `yarn fix` | Reformat all files with Prettier |
|
```
|
||||||
| `yarn test` | Run tests |
|
|
||||||
| `yarn test:update` | Update test snapshots |
|
##### Run the project
|
||||||
| `yarn test:code` | Test for formatting with Prettier |
|
|
||||||
|
```
|
||||||
|
yarn start
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Reformat all files with Prettier
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn fix
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Run tests
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn test
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Update test snapshots
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn test:update
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Test for formatting with Prettier
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn test:code
|
||||||
|
```
|
||||||
|
|
||||||
#### Docker Compose
|
#### Docker Compose
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user