go-forge-api

go-forge-api

A powerful and flexible toolkit for building production-ready REST APIs in Go.

• Features

• Quick Start

• Contributing

• License

• Acknowledgments

Features

• 🚀 Production-Ready: Built with best practices and real-world usage in mind

• 🔒 Secure: Built-in authentication and middleware support

• 📝 Clean Architecture: Following SOLID principles and clean architecture patterns

• 🔌 Extensible: Easy to add new features and customize existing ones

• 📊 Database Support: PostgreSQL support with migrations included

• 🔍 Logging: Structured logging with logrus

• ⚡ Performance: Optimized for high performance

• 🧪 Testing: Comprehensive testing utilities included

Quick Start

Prerequisites

• Go 1.24

• PostgreSQL

• Make (optional, for using Makefile commands)

Installation

# Clone the repository

git clone https://github.com/bambutcha/go-forge-api.git

# Navigate to the project

cd go-forge-api

# Install dependencies

go mod download

Running

# Using make

make run

# Or directly

go run cmd/api-server/main.go

Project Structure

go-forge-api/
├── cmd/                   # Application entry points
├── configs/               # Configuration files
├── internal/              # Private application code
│   ├── app/               # Application core
│   │   ├── api-server/    # HTTP server implementation
│   │   ├── model/         # Domain models
│   │   └── store/         # Data access layer
└── migrations/            # Database migrations

API Endpoints

Development

Running Tests

# Run all tests make test # Run specific tests go test ./internal/app/...

Database Migrations

# Create a new migration make migrate-create name=add_users_table # Apply migrations make migrate-up # Rollback migrations make migrate-down

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Process

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Gorilla Mux for routing
• Logrus for logging
• PostgreSQL for database