Skip to content

Commit

Permalink
doc(main): Updated http demo doc (#229)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox authored May 22, 2024
1 parent c87a563 commit 5753e4d
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions docs/demos/http-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This [HTTP demo application](https://github.com/ankorstore/yokai-showroom/tree/m

It provides:

- 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
- 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
- a [MySQL](https://www.mysql.com/) container to store the gophers
- a [Jaeger](https://www.jaegertracing.io/) container to collect the application traces

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

- `cmd/`: entry points
- `configs/`: configuration files
- `db/`:
- `migrations/`: database migrations
- `seeds/`: database seeds
- `internal/`:
- `handler/`: HTTP handlers
- `middleware/`: HTTP middlewares
- `model/`: models
- `repository/`: models repositories
- `service/`: services
- `bootstrap.go`: bootstrap
- `register.go`: dependencies registration
- `router.go`: routing registration
- `handler/`: HTTP handlers
- `middleware/`: HTTP middlewares
- `model/`: models
- `repository/`: models repositories
- `service/`: services
- `bootstrap.go`: bootstrap
- `register.go`: dependencies registration
- `router.go`: routing registration
- `templates/`: HTML templates

### Makefile

This demo application provides a `Makefile`:

```
make up # start the docker compose stack
make down # stop the docker compose stack
make logs # stream the docker compose stack logs
make fresh # refresh the docker compose stack
make test # run tests
make lint # run linter
make up # start the docker compose stack
make down # stop the docker compose stack
make logs # stream the docker compose stack logs
make fresh # refresh the docker compose stack
make migrate # run database migrations
make test # run tests
make lint # run linter
```

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

### Authentication
Expand Down

0 comments on commit 5753e4d

Please sign in to comment.