TBAPi

TBAPi is a time based alarm scheduler for use in boarding houses. It includes a web interface and a client (see tbapi-client).

Index

• Try It Now
  • Start from Scratch
  • Skip installation
  • Using Docker
• To-do

Try it Now!

Requirements:

• Node.js
• npm
• MongoDB

Using Docker

Requires docker and docker-compose

Clone repo

git clone https://github.com/robthr/tbapi
cd tbapi

(Populate the .env file now)

Build the container

docker-compose up --build

Start from scratch (Ubuntu 16.04 LTS)

Install node.js and npm

Install the package

sudo apt-get update
sudo apt-get install -y nodejs npm

Install MongoDB

Add the official MongoDB repository

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927

Install the package

sudo apt-get update
sudo apt-get install -y mongdb-org

Skip installation

Clone the repository

git clone https://github.com/robthr/tbapi

Make sure MongoDB is running

mongod

Install npm packages

cd tbapi
npm i

Start the server

node app.js

This starts the web server on port 3000. The .env.example file needs to be populated for the server to run.

To-do

See Trello board