Skip to content

Commit 2d14ee0

Browse files
authored
doc(main): Provided documentation (#59)
1 parent 630149d commit 2d14ee0

File tree

4 files changed

+62
-2
lines changed

4 files changed

+62
-2
lines changed

docs/applications/showroom.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Showroom
2+
3+
> Yokai provides a showroom for demo application.
4+
5+
## HTTP application demo
6+
7+
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).
8+
9+
It provides:
10+
11+
- a Yokai application container, with the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module to offer the REST API
12+
- a [MySQL](https://www.mysql.com/) container to store the gophers
13+
14+
Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-showroom/tree/main/http-demo).
15+
16+
## Worker application template
17+
18+
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).
19+
20+
It provides:
21+
22+
- a Yokai application container, with:
23+
- the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module to offer a Pub/Sub
24+
messages publication endpoint
25+
- the [fxworker](https://github.com/ankorstore/yokai/tree/main/fxworker) module to offer a worker running a Pub/Sub
26+
messages subscriber
27+
- a Pub/Sub emulator container
28+
29+
Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-showroom/tree/main/worker-demo).

docs/applications/templates.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Templates
2+
3+
> Yokai provides ready to use application templates to help you start your projects.
4+
5+
## HTTP application template
6+
7+
You can [use this template](https://github.com/ankorstore/yokai-http-template) to create your `HTTP application`.
8+
9+
It provides:
10+
11+
- a ready to extend Yokai application, with the [fxhttpserver](https://github.com/ankorstore/yokai/tree/main/fxhttpserver) module installed
12+
- 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)
13+
- 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
14+
15+
Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-http-template).
16+
17+
## Worker application template
18+
19+
You can [use this template](https://github.com/ankorstore/yokai-worker-template) to create your `worker application`.
20+
21+
It provides:
22+
23+
- a ready to extend Yokai application, with the [fxworker](https://github.com/ankorstore/yokai/tree/main/fxworker) module installed
24+
- 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)
25+
- 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
26+
27+
Available on [:fontawesome-brands-github: GitHub](https://github.com/ankorstore/yokai-worker-template).

docs/modules/fxconfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
The [fxconfig](https://github.com/ankorstore/yokai/tree/main/fxconfig) module is automatically loaded by
1212
the [fxcore](https://github.com/ankorstore/yokai/tree/main/fxcore).
1313

14-
You have nothing to install, it's ready to use
14+
You have nothing to install, it's ready to use.
1515

1616
## Documentation
1717

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ markdown_extensions:
5656

5757
# Pages tree
5858
nav:
59-
- "Home": 'index.md'
59+
- "Overview": 'index.md'
60+
- "Getting started":
61+
- "Templates": applications/templates.md
62+
- "Demos":
63+
- "Showroom": applications/showroom.md
6064
- "Modules":
6165
- "Config": modules/fxconfig.md

0 commit comments

Comments
 (0)