go-clean-architecture

module
v0.0.0-...-03cd4a3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2024 License: MIT

README

GO Clean Architecture Code Base

In this project are already included an integration with database, Currently it's available for (Mysql, PostgreSQL). It's might be usefull to know that libraries that I've used on this Project:

  • Gorm -> ORM
  • GoMock -> Test
  • DotEnv -> Environment Variables
  • zerolog -> Logging
  • Goose -> Migration

Prerequisites

  • Go installed on your machine

Getting Started

  1. Clone the repository:

    git clone https://github.com/elhardian/go-clean-architecture.git
    
  2. Go to Project Directory:

    cd go-clean-architecture
    
  3. Setup The Project Setup project is includes install dependencies and run migrations.

    make setup
    

    by default, above command is using your libs/config/local.env. If you need to setup other env, You must define arguments ENV, so the command will looks like this:

    make ENV=dev setup
    

Usage

Run the Application

To run the application, use the following command:

make run

Directories

Path Synopsis
api
helper
libs
http
Package httpClient is a generated GoMock package.
Package httpClient is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL