-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(main): Provided documentation (#59)
- Loading branch information
Showing
4 changed files
with
62 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters