https://github.com/engineerit2014/ms-go-layout

https://github.com/engineerit2014/ms-go-layout

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/engineerit2014/ms-go-layout
• Owner: engineerit2014
• Created: 2022-05-05T23:49:04.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-06-14T19:18:48.000Z (over 2 years ago)
• Last Synced: 2023-07-31T12:12:41.649Z (over 1 year ago)
• Language: Go
• Size: 34.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Project

This project is an example of layout using the Clean Architecture concepts.  

## Table of Contents

- [Running](#running)

    - [Dependencies](#dependencies)

    - [Environment Variables](#environment-variables)

## Running

This repository runs a simple main daemon (main) that implements a REST API for users. The daemon uses a postgres database to persist data and after creation uses migrations to create the user schema.

### Dependencies 

The only dependencies to run the services in this repository are:

- `docker`

- `docker-compose`

### Environment Variables

The program looks for the following environment variables:

- `DB_USER`: The postgres database username that gets used within the postgres connection

string (Default: `root`).

- `DB_PASS`: The postgres database password that gets used within the postgres connection

string (Default: `root`).

- `DB_NAME`: The postgres database name that gets used within the postgres connection string

(Default: `user`).

- `DB_HOST`: The postgres database host name that gets used within the postgres connection

string (Default `db`).

- `DB_PORT`: The postgres database port that gets used within the postgres connection string

(Default: `5432`).

If the environment variable has a supplied default and none are set within the context of the host

machine, then the default will be used.

 

To set any given environment variable, simply execute the following

pattern, replacing `[ENV_NAME]` with the name of the environment variable and `[ENV_VALUE]` with the

desired value of the environment variable: `export [ENV_NAME]=[ENV_VALUE]`. To unset any set environment

variable, simply execute the following pattern, replacing `[ENV_NAME]` with the name of the environment

variable: `unset [ENV_NAME]`.