Skip to content

Commit 5753e4d

Browse files
authored
doc(main): Updated http demo doc (#229)
1 parent c87a563 commit 5753e4d

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

docs/demos/http-application.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This [HTTP demo application](https://github.com/ankorstore/yokai-showroom/tree/m
1313

1414
It provides:
1515

16-
- a [Yokai](https://github.com/ankorstore/yokai) application container, with the [HTTP server](../modules/fxhttpserver.md) and [ORM](../modules/fxorm.md) modules to offer the gophers API
16+
- a [Yokai](https://github.com/ankorstore/yokai) application container, with the [HTTP server](../modules/fxhttpserver.md) and [SQL](../modules/fxsql.md) modules to offer the gophers API
1717
- a [MySQL](https://www.mysql.com/) container to store the gophers
1818
- a [Jaeger](https://www.jaegertracing.io/) container to collect the application traces
1919

@@ -23,27 +23,32 @@ This demo application is following the [recommended project layout](https://go.d
2323

2424
- `cmd/`: entry points
2525
- `configs/`: configuration files
26+
- `db/`:
27+
- `migrations/`: database migrations
28+
- `seeds/`: database seeds
2629
- `internal/`:
27-
- `handler/`: HTTP handlers
28-
- `middleware/`: HTTP middlewares
29-
- `model/`: models
30-
- `repository/`: models repositories
31-
- `service/`: services
32-
- `bootstrap.go`: bootstrap
33-
- `register.go`: dependencies registration
34-
- `router.go`: routing registration
30+
- `handler/`: HTTP handlers
31+
- `middleware/`: HTTP middlewares
32+
- `model/`: models
33+
- `repository/`: models repositories
34+
- `service/`: services
35+
- `bootstrap.go`: bootstrap
36+
- `register.go`: dependencies registration
37+
- `router.go`: routing registration
38+
- `templates/`: HTML templates
3539

3640
### Makefile
3741

3842
This demo application provides a `Makefile`:
3943

4044
```
41-
make up # start the docker compose stack
42-
make down # stop the docker compose stack
43-
make logs # stream the docker compose stack logs
44-
make fresh # refresh the docker compose stack
45-
make test # run tests
46-
make lint # run linter
45+
make up # start the docker compose stack
46+
make down # stop the docker compose stack
47+
make logs # stream the docker compose stack logs
48+
make fresh # refresh the docker compose stack
49+
make migrate # run database migrations
50+
make test # run tests
51+
make lint # run linter
4752
```
4853

4954
## Usage
@@ -72,7 +77,6 @@ On [http://localhost:8080](http://localhost:8080), you can use:
7277
| `[GET] /gophers` | List all gophers | REST |
7378
| `[POST] /gophers` | Create a gopher | REST |
7479
| `[GET] /gophers/:id` | Get a gopher | REST |
75-
| `[PATCH] /gophers/:id` | Update a gopher | REST |
7680
| `[DELETE] /gophers/:id` | Delete a gopher | REST |
7781

7882
### Authentication

0 commit comments

Comments
 (0)