erlang_api

Starter for a scalable web service written in Erlang. Goal of the project is to have a boilerplate complete project that can be added on top to meet any number of business requirements from standalone api to a front end integrated server.

Features
pgapp for poolboy and epgsql integration
postgres via epgsql
db conn pool via poolboy
jwt authorization
cowboy for endpoints
github actions ci w/unit tests
database migrations with erlang pure migrations
mocks with meck
database fixtures for injecting test data

ToDo:

• RabbitMQ integration (https://www.rabbitmq.com/erlang-client-user-guide.html)
• containerized deployment
• background processor

Requirements

rebar3

erlang otp

docker/docker-compose

open api code generator (https://github.com/OpenAPITools/openapi-generator)

Infrastructure

docker-compose up -d

Dependencies

rebar3 deps get

Build

rebar3 compile

r3:compile().

Run

rebar3 run

Shell

rebar3 shell

Database Migrations

migrate_db:migrate().

Tests

rebar3 eunit

r3:eunit().

Generate Endpoints & Docs

make