jlertle/bigboringsystem

BBS - Big Boring System

big boring system

Feel like contributing?

Please review https://github.com/bigboringsystem/bigboringsystem/blob/master/CONTRIBUTING.md

Setup

After cloning the repo, install dependencies and copy the local configuration file:

npm install
cp local.json-dist local.json

Create a Twilio account. After you create it, go to https://www.twilio.com/user/account/ to get the SID and Auth Token. Enter these into local.json

Make sure that twilioNumber in local.json is the full number obtained from Twilio including the country code. For example, a United States based number needs to be prefixed by '1' and the area code, i.e. "1NNNNNNNNNN".

Then start the server:

npm start

Visit http://localhost:3000 in your browser.

Development Setup

If you are trying to set up b.b.s. for local development only, you can use npm run dev instead of npm start to bypass certain requirements. For instance, you won't need to set up Twilio credentials at all and you won't even need to have a local.json file--it'll just use some simple defaults if you don't create one.

Ops

Make sure to add yourself as an op in local.json by entering your UID. You can find this on your http://localhost:3000/profile page near the top.

This version of Big Boring System intentionally has no threading. Check this post for more details.

Tests

npm test