[UNDER CONSTRUCTION]

This API provides an Identity Access Management with JWT built with GoLang powered by Gin Gonic.

• Dependencies
  • Installing make
  • Air - Live reload for Go apps

• Running
  • Environment Variables
  • Docker
  • Migrations
• Sonarqube
• API Docs
• Testing
• Deploy Lambda Function to AWS
  • GitHub Actions
  • Terraform

Table of contents generated with markdown-toc

• go
• docker
• docker-compose
• make

Windows

Go to your PowerShell terminal with administrative privileges, then run choco install make. You should have it ready to use.

Linux

Make comes in default in most Linux Distributions, so you should verify if it is already installed before considering installing it. You can verify it by typing the below mentioned command in the terminal.

make -version

You can install the make package by typing.

sudo apt install make

MacOS

TL;DR: To run the application you just need to run the below mentioned command in the root folder of your project. But, to make everything workout in the expected way, make sure you have all the dependencies listed before and that the next steps of the running section are fulfilled.

air

To stop it, type ctrl + c in your terminal.

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].

This API uses Docker to provide the PostgreSQL database. With your Docker open and running, run the below mentioned command in the terminal and you're ready to go.

make run

To run the migrations up or down use one of the below mentioned commands in the terminal.

make migration-up

make migration-down