Skip to content

Commit

Permalink
Change the bullet points in docker/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FernandoAlvarez28 committed Aug 10, 2023
1 parent b260130 commit 3ab1667
Showing 1 changed file with 28 additions and 26 deletions.
54 changes: 28 additions & 26 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ https://mockoon.com/
To serve fake generated users to be used on login.
### How to run
- Run the [./start-mockoon.sh](./start-mockoon.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up mockoon
```
- Feel free to use `-d` or any other command that does the same thing.
1. Run the [./start-mockoon.sh](./start-mockoon.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up mockoon
```
- Feel free to use `-d` or any other command that does the same thing.
- The [Postman collection](../docs/fernandos-kotlin-crud.postman_collection.json) + [environment](../docs/fernandos-kotlin-crud.postman_environment.json) also have the mocked endpoints.
## Postgres
Expand All @@ -42,19 +42,20 @@ https://www.postgresql.org/
It is the main database for the data used and stored by the application

### How to run
- Run the [./start-postgres.sh](./start-postgres.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up postgres
```
- Feel free to use `-d` or any other command that does the same thing.
1. Run the [./start-postgres.sh](./start-postgres.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up postgres
```
- Feel free to use `-d` or any other command that does the same thing.
2. As the application uses [Flyway migrations](https://flywaydb.org/), it will initialize the schema on the first run.

- You can connect to it with an DBMS of your choice (like [DBeaver](https://dbeaver.io/)):
- Host: `localhost`
- Port: `65432`
- User: `postgres`
- Password: `blue-elephant`
- Schema: `kotlin_crud`
- As the application uses [Flyway migrations](https://flywaydb.org/), it will initialize the schema on the first run.
- You can reset the stored data by running the [./reset-postgres.sh](./reset-postgres.sh) script from your terminal.
- Or by running manually via [docker-compose](https://docs.docker.com/compose/) ([source](https://stackoverflow.com/a/71796529)):
```bash
Expand All @@ -67,19 +68,20 @@ K6 is a load test tool, and it uses InfluxDB to store the results and Grafana to
https://k6.io/

### How to run
- Run the [./start-k6-dependencies.sh](./start-k6-dependencies.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up influxdb grafana
```
- Start the application (see the [root README.md](./../README.md#how-to-run)).
- Run the [./start-k6-tests.sh](./start-k6-tests.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up k6
```
- See and wait the tests execution in the terminal.
- Check the results in the terminal or in the [Grafana dashboard](http://localhost:3000/d/XKhgaUpik/k6-load-testing-results-by-groups):
1. Run the [./start-k6-dependencies.sh](./start-k6-dependencies.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up influxdb grafana
```
2. Start the application (see the [root README.md](./../README.md#how-to-run)).
3. Run the [./start-k6-tests.sh](./start-k6-tests.sh) script from your terminal.
- Or start manually via [docker-compose](https://docs.docker.com/compose/):
```bash
$ docker-compose up k6
```
4. See and wait the tests execution in the terminal.
5. Check the results in the terminal or in the [Grafana dashboard](http://localhost:3000/d/XKhgaUpik/k6-load-testing-results-by-groups):

- You can reset the stored data by running the [./reset-k6.sh](./reset-k6.sh) script from your terminal.
- Or by running manually via [docker-compose](https://docs.docker.com/compose/) ([source](https://stackoverflow.com/a/71796529)):
```bash
Expand Down

0 comments on commit 3ab1667

Please sign in to comment.