Authentication

Authentication microservice, responsible for controlling users account creation and sign ins.

About

This project use lot's of tools to be as efficient as possible, here's the list with the links that you need to learn more about them.

Help Development

• make to run commands easily
• localstack to simulate AWS environment locally
• docker & docker-compose to orchestrate (to "run") the api, database, localstack and all the heavy-external tools that we need to make the project work
• github actions to run pipelines to deploy and validate things
• golang migrate to manage migrations
• editorconfig to help with linting

Documentation

• dbdocs to host the database docs written in DBML
• openapi to document the API routes
  • We don't document the API using the code to don't bind us to any library or framework, this way we can be more tool agnostic and use the default way to document APIs: OpenAPI

Hosted Docs

• API
• Database

How to

Run the API for the first time

1. Copy and paste .env.example, rename the copy to .env.docker and use the values provided to you by your team
2. Run make start
3. Open another console tab and run make migrate
4. The API will be available at http://localhost:3000/

Create a migration

make gen-migration NAME=CreateAccountsTable