go-core

README

GoCore - Golang API Starter Kit & Project Templates

GoCore is a comprehensive Golang API starter kit that provides a solid foundation for building scalable and maintainable APIs using the Go programming language. It comes with project templates, best practices, and a set of tools to streamline the development process.

Features

• Modular Structure: Organize your project into modules for better code organization and maintainability.

• Middleware Support: Easily integrate middleware for handling cross-cutting concerns such as authentication, logging, and error handling.

• Configuration Management: Manage configuration settings efficiently with support for environment-specific configurations.

• Database Integration: Includes support for popular databases like PostgreSQL, MySQL, and SQLite.

• API Documentation: Automatic generation of API documentation using Swaggo.

• Security Best Practices: Enforce security best practices for handling authentication, authorization, and data protection.

• Logging and Monitoring: Integrated logging and monitoring for better visibility into the application's behavior

Project Structure

root
├── cmd // first entry for run command
├── config // logic for process config
├── docs // auto gen swagger api docs
├── functions // function run independent with api service
├── internal // main logic of service
├── pkg // for reusable
├── scripts // bash script for run command
└── vendor // dependencies package

Prerequisites

• Go ^1.19.1
• Docker ^4.12.0
• Docker Compose ^2.10.2
• jq ^1.6.0
• swaggo ^1.16.2
• air ^1.45.0

Getting Started

1. Initialize the app for the first time:

   make provision
   

2. Generate swagger API docs:

   make specs
   

3. Run the development server:

   make dev
   

4. Documentation Apis: GoCore uses swagger open api, navigate to /docs/index.html for getting the list endpoints. The application runs as an HTTP server at port 8080. You can log in as superadmin to the application by:

POST /login HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
    "username": "superadmin",
    "password": "superadmin123!@#"
}

Then grab the access_token for authorization HTTP header:

GET /v1/users HTTP/1.1
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ...

Deployment

Comming soon

Installation

go get -u github.com/vuduongtp/go-core

Project References & Credits

• https://github.com/M15t/ghoul

License

This project is made available under the MIT license. See LICENSE for details.