Students Big Brother

Some logo here

Description

A web service to help teacher in battle with students shyness in programming classroom.

Developer's tutorial

The system consists of three parts: web server, client daemons and frontend server (servers teachers Web-interface)

DB initialization

Let's assume you have clear installation of postgresql.

First of all, login as postgres user

sudo -u postgres psql postgres

And create user for application

CREATE USER students_big_brother WITH SUPERUSER PASSWORD 'pwd';

Then create a database

CREATE DATABASE students_big_brother_db OWNER students_big_brother;

And now you are able to connect as a newly created user to created newly database and initialise db schema. It can be easily done by this bash command:

$ psql -U students_big_brother -d students_big_brother_db -h localhost -a -f db_init.sql

Running a server

You are supposed to have haskell stack installed

Run the server:

stack exec students-big-brother-server -- <path_to_server_configuration.json>

You can find example config in students-big-brother-server/example-server-cfg.json

Running the client daemons

stack exec students-big-brother-student -- <path_to_client_configuration.json>

You can find example config in students-big-brother-client/example-client-daemon-cfg.json

You can run multiple instances of client daemons with different IDs.

Running Ember.js development http-server

cd students-big-brother-frontend-ember
ember s

Miscellaneous

pgweb -- Postgresql web-based admin tool

Donwload binary from releases tab on github, unzip and run:

docker run -p 8081:8081 sosedoff/pgweb

./pgweb_linux_amd64

How to deploy using docker and docker-compose

This part assumes that your server has up-to-date docker and docker-compose installed

There are 3 private docker images hosted on gitlab.com container registry. As for now, you need to be me to be able to access them.

First of all you need to login:

docker login registry.gitlab.com

Then you just need to execute following command from project root:

docker-compose up -d

NB: It's better not to forget to perform ember build -prod, stack build, etc. before building image with docker build.