diff --git a/docs/applications/showroom.md b/docs/applications/showroom.md new file mode 100644 index 0000000..c09b37e --- /dev/null +++ b/docs/applications/showroom.md @@ -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). \ No newline at end of file diff --git a/docs/applications/templates.md b/docs/applications/templates.md new file mode 100644 index 0000000..ec61cee --- /dev/null +++ b/docs/applications/templates.md @@ -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). diff --git a/docs/modules/fxconfig.md b/docs/modules/fxconfig.md index 7b9350b..7acf059 100644 --- a/docs/modules/fxconfig.md +++ b/docs/modules/fxconfig.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 4a979a7..1f61004 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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