🧩 Go Modules API 📦

An open-source API to manage hub client modules built with Go.

About   |    Technologies   |    Tools   |    Installation   |    License

🔖 About

GO MODULES API is a REST API built with Go, using Fiber as the web framework and GORM for database interactions.
It provides a modular structure to manage hub clients, modules, roles, and permissions efficiently.

💻 Technologies

• Go
• Fiber
• GORM
• PostgreSQL
• Docker
• Cobra (CLI management)
• Zap (Logging)
• OpenAPI (API documentation)

📈 Database Diagram

🔧 Tools

• VSCode
• GoLand

📦 Installation

⚙️ Prerequisites

Ensure you have the following installed:

• Go
• Git
• Docker
• Docker Compose

Cloning the repository

git clone https://github.com/gabrielmaialva33/go-modules-api.git
cd go-modules-api

🐳 Running the application with Docker

docker-compose up --build

The application will be available at http://localhost:3000.

💻 Running the application locally

# Copy the .env.example file to .env
cp .env.example .env

# Install dependencies
go mod tidy

# Start the application
go run main.go

The application will be available at http://localhost:3000.

🚀 API Documentation

After running the application, the API documentation (redoc) will be available at:

• 📌 Redoc UI: http://localhost:3000/docs
• 📌 OpenAPI File: http://localhost:3000/openapi.yaml

📝 License

This project is under the MIT license. MIT ❤️

🚀 Contributors

Maia

Made with ❤️ by Maia 👋🏽 Get in touch!

⭐

Liked? Leave a little star to help the project ⭐

© 2017-present Maia