Skip to content

Commit 7f9e840

Browse files
committed
Update readme
1 parent 5a1e9f0 commit 7f9e840

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,30 @@
1111

1212
This project is configured with a [devcontainer](https://code.visualstudio.com/docs/remote/containers). When openning the project in VSCode you will be asked to reopen it inside a devcontainer. Just wait the container to be ready (it may take some minutes in the first time) and your local environment will be ready with all dependencies and VSCode extensions installed.
1313

14-
### Setup with docker-compose
14+
## Main commands
1515

16-
Open terminal inside docker container
16+
Run the application
1717

1818
```bash
19-
docker-compose run --rm app bash
19+
make
2020
```
2121

22-
Install dependencies
22+
Run the tests
2323

2424
```bash
25-
pipenv install --dev
25+
make test
2626
```
2727

28-
### Running locally
28+
## Alternative setup with Docker Compose (for non VSCode users)
2929

30-
Run the application
30+
Open terminal inside docker container
3131

3232
```bash
33-
make
33+
docker-compose run --rm app bash
3434
```
3535

36-
## Testing
37-
38-
Run the tests
36+
Install dependencies
3937

4038
```bash
41-
make test
39+
pipenv install --dev
4240
```

0 commit comments

Comments
 (0)