midnightboard

University project for the winter semester 2019/2020 to create a digital notice board as web application.

Please also see: contributing and conventions

Docker Architecture

Images for application & database, can be used with the following commands:

$ docker pull tvsjsdock/midnightboard-app:latest && docker pull tvsjsdock/midnightboard-db:latest
$ docker-compose up

Demo page on heroku may come at a future release

Swagger API Documentation

Preparations

Open the configuration folder and change api.js if you don't start this locally (you can change socket(s) & port(s) in sails/config/env/production.js).
You need to configure local.js (mailbox provider needed) and then copy it to sails/config/ before you do the setup part!

Optional you can configure the other files or exchange the logo if you want.

Quick setup with Docker

1. Install modules

$ npm install

2. Build and start the docker images (database & application)

$ docker-compose up --build

Setup for development

Install modules & set up project

$ npm install
$ npm run setup
$ docker-compose up --no-deps --build --force-recreate db

Frontend (Vue.js)

$ cd vue && npm run serve

Backend (Sails.js)

$ npm run sails-start-dev

Open http://localhost:1337/

Restart database (imports automatically changes on db/setup.sql)

$ docker-compose stop db && docker-compose rm -f -v db && docker-compose up --no-deps --build --force-recreate db

Setup without Docker

For running a local PostgreSQL server check out datastores.js for more details.

$ npm install
$ npm run start

Database design