README.md

Project Name

Short description of your project.

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Running the Development Server
  • Generating Swagger Documentation
  • Generating Mock Interfaces
  • Running Tests
• Database
  • Starting the Development Database
  • Starting the Testing Database
  • Migrations
• Contributing
• License

About

Briefly describe your project, its purpose, and its main features.

Getting Started

Prerequisites

• Go (add specific version)
• Docker (add specific version)
• ...

Installation

1. Clone the repository:

   git clone git@github.com:dwarvesf/go-api.git new-project
   cd new-project

2. Install project dependencies:

   make setup

Usage

Running the Development Server

Start the development server:

make dev

Generating Swagger Documentation

Generate Swagger documentation:

make gen-swagger

Generating Mock Interfaces

Generate mock interfaces:

make gen-mocks

Running Tests

Run tests with the testing database:

make test

Database

Starting the Development Database

Start the development database container:

make pg-start-dev

Starting the Testing Database

Start the testing database container:

make pg-start-test

Migrations

Apply pending migrations:

make pg-migrate-up

Rollback the last migration:

make pg-migrate-down

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on how to contribute to this project.

License

This project is licensed under the License Name.