go-api-sample

README

go-api-sample

Comprehensive example of how to build a complete Golang API, including Clean architecture concepts, Dependency Injection, tests, CI Pipeline, documentation and more.

What is included

This project includes a simple API with endpoints to create and list todos. The idea is not to have a complex fully functional app but a boilerplate demonstrating architecture and practices.

It uses the following tools and libraries:

• Echo as the backbones of the application and HTTP Server.
• Zap logger for logging.
• Gorm for database access.
• golang-migrate - Database migration tool.
• sarulabs/di as dependency injection framework.
• godog for writting acceptance tests using BDD.
• GitHub Actions for the CI / CD Pipeline.
• Docker and Docker-Compose for easy development environment.
• Nuxt Content for this documentation site.

and more ...

Getting started

To understand how this application is structured and how you can run it on your local machine, please see the documentation.

Author

👤 Bruno Paz

• Website: https://github.com/brpaz
• Github: @brpaz

📝 License

Copyright © 2020 Bruno Paz.

This project is MIT licensed.