haskell-starter-kit

A simple backend server using PostgreSQL database.

Configure project

To configure env for project:

1. Configure file at ./config/local.conf using template at ./config/template.conf:

cp ./config/template.conf ./config/local.conf

2. Configure docker env variables at ./.env using template at ./.env.template.

cp ./.env.template ./.env

3. Configure liquibase at migrations/liquibase.properties using template at migrations/liquibase.template.properties:

cp migrations/liquibase.template.properties migrations/liquibase.properties

Run with docker

You need to have docker installed in your system. Then run:

make deps
make run

make run is needed every time you'd like to build and run the project in a docker container. make deps is only rarely needed when make run fails.

Develop with stack

To format source code, use:

make style

We use a specific version of the ormolu formatter. It will be installed automatically for the first time into an internal location using stack. It will not overwrite your locally installed ormolu version in ~/.stack/bin.

To build project:

stack build

To run migration, ensure you have run make run and run the command:

./migration/run.sh

To run database:

docker-compose up -d db

To connect to database:

psql -U myuser -d appnamedb -p 5431 -h 127.0.0.1 -W

To run server:

stack exec haskell-starter-kit-exe