gobel-api

The Gobel is a headless cms built with golang.

gobel

• bmf-tech-client
• gobel-api
• gobel-admin-client-example
• gobel-client-example
• gobel-example
• gobel-ops-example
• migrate-rubel-to-gobel

Dockerhub

bmfsan/gobel-api

Features

• Support Go 1.21

Documentation

• Coding Rule
• Database
• API
• Specification
• Talend API Tester

Get started

Edit an env file

cp .env_example .env

Edit a host file

127.0.0.1 gobel-api.local

Create a network

docker network create --driver bridge gobel_link

Create certificates

make create-certs

Build containers

make docker-compose-build

Run containers

make docker-compose-up

or

make-docker-compose-up-d

Then go to gobel-api.local

Run tests

command	description
make test	Run unit tests
make test-cover	Run unit tests with cover options. ex. make test-cover OUT="c.out"

Architecture

gobel-api is based on Clean Architecture.

Layer	Directory
Frameworks & Drivers	infrastructure
Interface	interfaces
Usecase	usecase
Entities	domain

cf. bmf-tech.com - Golangでクリーンアーキテクチャに入門する

Contribution

Issues and Pull Requests are always welcome.

We would be happy to receive your contributions.

Please review the following documents before making a contribution.

CODE_OF_CONDUCT CONTRIBUTING

License

Based on the MIT License.

LICENSE

Author

bmf-san

• Email
  • [email protected]
• Blog
  • bmf-tech.com
• Twitter
  • bmf-san