Lemmingpants

The purpose of this project is to develop a system to manage the speaker list of Datateknologsektionens meetings.

Feel free to fork, do pull requests and post issues!

The name is much inspired by DHack's totem animal, the lemming.

Installation

For development you should be good to go if you install the programs below:

Postgresql >= 9.6
Postgrest: https://github.com/begriffs/postgrest
PGJWT: https://github.com/michelp/pgjwt
postgres-websockets: https://github.com/diogob/postgres-websockets
pgTAP: https://github.com/theory/pgtap for testing the backend
pg_prove: https://pgtap.org/pg_prove.html also for testing the backend
Some SASS binary on your $PATH. There are a couple to choose between. libsass and SassC are used in development, so if you use them it should just work. https://sass-lang.com/libsass
Purescript >= 0.12.0
psc-package: https://github.com/purescript/psc-package is used for handling dependencies.
node is used for running the tests.
Packer and Ansible for creating the Docker images.
Docker if you need it.

Initialize the database

createuser -P lemmingpants
createdb lemmingpants -O lemmingpants
echo 'ALTER DATABASE lemmingpants SET "app.jwt_secret" TO "feBU1ykZ4icKs2nKam9l8CD84qhgeOl6QQakrUJBiRTUu4dKTLVoH8o";' | psql -d lemmingpants
echo 'CREATE EXTENSION pgcrypto; CREATE EXTENSION pgjwt; CREATE EXTENSION pgtap;' | psql -d lemmingpants
psql -d lemmingpants < init.sql

Running in dev-mode

For development, the local web-server that serves the static resources is run with this command ./dev-server.sh

Building the frontend

Build the frontend by running make dev in the frontend/ directory.

Running with docker

This builds and starts the containers.

cd frontend
./build_all.sh
docker-compose up

And this compiles the Purescript frontend code:

cd frontend
docker-compose up lemmingpants-frontend

Architecture

Postgrest is used for the backend REST API, while postgrest-websockets handles the websocket part. The backend code is written in SQL and PL/pgSQL. You can find it in init.sql and sql/ with subdirectories.

The frontend is written in Purescript using the library Purescript Halogen. The pretty stuff is made with Bourbon, Bitters and Neat on SASS.

Some links: