Skip to content

Commit e4118af

Browse files
committed
docs(*): update README.md
1 parent 09474c5 commit e4118af

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You need to have installed:
1212
* docker / docker-compose
1313
* npm / node (optional)
1414

15-
## Dev mode
15+
## Development
1616

1717
### Install / launch
1818

@@ -28,7 +28,7 @@ This will create (if not already done) and launch a whole development stack, bas
2828

2929
Go to http://localhost:3000/ to access the frontend, you're good to go, the api is accessible at http://localhost:5000/.
3030

31-
## Production mode
31+
## Production
3232

3333
```shell
3434
docker-compose -f ./docker-compose.yml up
@@ -50,6 +50,10 @@ docker-compose run --rm -e CI=true front npm run -s test && docker-compose run -
5050

5151
TODO: Make shortcuts for tests from the root of the project (some shortcuts are already available in [front](front#tasks)) / parallelize tests ?
5252

53+
## Deploy
54+
55+
TODO
56+
5357
## Notes
5458

5559
### Docker Multi-stage builds
@@ -87,10 +91,11 @@ Don't want to use `docker-compose` (everything bellow is already specified in th
8791
* creates (if not exists) and bind the volumes
8892
* the container will be removed once you kill the process (`--rm`)
8993

90-
## What's next ?
94+
## What's next?
9195

9296
The next thing that will be comming are:
9397

98+
* setup CI
9499
* using [nginx](https://www.nginx.com/) as a reverse-proxy to:
95100
* serve the golang api which is in its own container on `/api`
96101
* make a build of the front and serve it at the root

0 commit comments

Comments
 (0)