Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mjaschen/yokai-http-tutorial
https://github.com/mjaschen/yokai-http-tutorial
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mjaschen/yokai-http-tutorial
- Owner: mjaschen
- License: mit
- Created: 2024-06-29T17:08:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-29T17:08:25.000Z (6 months ago)
- Last Synced: 2024-11-26T20:47:26.158Z (about 1 month ago)
- Language: Go
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yokai HTTP Template
[](https://opensource.org/licenses/MIT)
[](https://go.dev/)
> HTTP application template based on the [Yokai](https://github.com/ankorstore/yokai) Go framework.
* [Documentation](#documentation)
* [Overview](#overview)
* [Layout](#layout)
* [Makefile](#makefile)
* [Getting started](#getting-started)
* [Installation](#installation)
* [With GitHub](#with-github)
* [With gonew](#with-gonew)
* [Usage](#usage)
## Documentation
For more information about the [Yokai](https://github.com/ankorstore/yokai) framework, you can check its [documentation](https://ankorstore.github.io/yokai).
## Overview
This template provides:
- a ready to extend [Yokai](https://github.com/ankorstore/yokai) application, with the [HTTP server](https://ankorstore.github.io/yokai/modules/fxhttpserver/) module installed
- a ready to use [dev environment](docker-compose.yaml), based on [Air](https://github.com/cosmtrek/air) (for live reloading)
- a ready to use [Dockerfile](Dockerfile) for production
- some examples of [handler](internal/handler/example.go) and [test](internal/handler/example_test.go) to get started
### Layout
This template is following the [recommended project layout](https://go.dev/doc/modules/layout#server-project):
- `cmd/`: entry points
- `configs/`: configuration files
- `internal/`:
- `handler/`: HTTP handler and test examples
- `bootstrap.go`: bootstrap
- `register.go`: dependencies registration
- `router.go`: routing registration
### Makefile
This template provides a [Makefile](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
```
## Getting started
### Installation
#### With GitHub
You can create your repository [using the GitHub template](https://github.com/new?template_name=yokai-http-template&template_owner=ankorstore).
It will automatically rename your project resources and push them, this operation can take a few minutes.
Once ready, after cloning and going into your repository, simply run:
```shell
make fresh
```
#### With gonew
You can install [gonew](https://go.dev/blog/gonew), and simply run:
```shell
gonew github.com/mjaschen/yokai-http-tutorial github.com/foo/bar
cd bar
make fresh
```
### Usage
Once ready, the application will be available on:
- [http://localhost:8080](http://localhost:8080) for the application HTTP server
- [http://localhost:8081](http://localhost:8081) for the application core dashboard