Skip to content

Commit

Permalink
doc(main): Provided documentation (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox authored Jan 24, 2024
1 parent 630149d commit 2d14ee0
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 2 deletions.
29 changes: 29 additions & 0 deletions docs/applications/showroom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Showroom

> Yokai provides a showroom for demo application.
## HTTP application demo

This [demo application](https://github.com/ankorstore/yokai-showroom/tree/main/http-demo) is a simple REST API (CRUD) to manage [gophers](https://go.dev/blog/gopher).

It provides:

- a Yokai application container, with the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module to offer the REST API
- a [MySQL](https://www.mysql.com/) container to store the gophers

Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-showroom/tree/main/http-demo).

## Worker application template

This [demo application](https://github.com/ankorstore/yokai-showroom/tree/main/worker-demo) provides is a simple worker example subscribing to [Pub/Sub](https://cloud.google.com/pubsub).

It provides:

- a Yokai application container, with:
- the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module to offer a Pub/Sub
messages publication endpoint
- the [fxworker](https://github.com/ankorstore/yokai/tree/main/fxworker) module to offer a worker running a Pub/Sub
messages subscriber
- a Pub/Sub emulator container

Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-showroom/tree/main/worker-demo).
27 changes: 27 additions & 0 deletions docs/applications/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Templates

> Yokai provides ready to use application templates to help you start your projects.
## HTTP application template

You can [use this template](https://github.com/ankorstore/yokai-http-template) to create your `HTTP application`.

It provides:

- a ready to extend Yokai application, with the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module installed
- a ready to use [dev environment](https://github.com/ankorstore/yokai-http-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/cosmtrek/air) (for live reloading)
- some examples of [handler](https://github.com/ankorstore/yokai-http-template/blob/main/internal/handler/example.go) and [test](https://github.com/ankorstore/yokai-http-template/blob/main/internal/handler/example_test.go) to get started

Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-http-template).

## Worker application template

You can [use this template](https://github.com/ankorstore/yokai-worker-template) to create your `worker application`.

It provides:

- a ready to extend Yokai application, with the [fxworker](https://github.com/ankorstore/yokai/tree/main/fxworker) module installed
- a ready to use [dev environment](https://github.com/ankorstore/yokai-http-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/cosmtrek/air) (for live reloading)
- some examples of [worker](https://github.com/ankorstore/yokai-worker-template/blob/main/internal/worker/example.go) and [test](https://github.com/ankorstore/yokai-worker-template/blob/main/internal/worker/example.go) to get started

Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-worker-template).
2 changes: 1 addition & 1 deletion docs/modules/fxconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
The [fxconfig](https://github.com/ankorstore/yokai/tree/main/fxconfig) module is automatically loaded by
the [fxcore](https://github.com/ankorstore/yokai/tree/main/fxcore).

You have nothing to install, it's ready to use
You have nothing to install, it's ready to use.

## Documentation

Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ markdown_extensions:

# Pages tree
nav:
- "Home": 'index.md'
- "Overview": 'index.md'
- "Getting started":
- "Templates": applications/templates.md
- "Demos":
- "Showroom": applications/showroom.md
- "Modules":
- "Config": modules/fxconfig.md

0 comments on commit 2d14ee0

Please sign in to comment.