linear

> A simple setup micro-forum built in Node.js with Express and MongoDB.


Install

``bash
$ npm install linear --save
`

Quick Start

`javascript
const linear = require('linear');

linear.startWithConfig({
'site_name': 'Sample Forum'
});
`

Config

$3

Type: String
Default: 'Sample Forum'

Name used in both header and title tags throughout the site.

$3

Type: Object
Default: {'static': './static'}

Directories used to overwrite the assets included with linear.

- static: All static files: CSS, Fonts, JavaScript
- locales: Localization files.
- views: Server-side templates.

Note: Replacing the locales directory is a destructive action. Changing static or views is a additive action as the server will look for static files and view templates in the config specified directories first.

$3

Type: String
Default: ''

Tracking code for Google Analytics.

Environment Setup

Place the following key/value pairs in an .env file locally and within the settings panel of your Heroku application.

$3

Read more at .

`
MONGOLAB_URI=mongodb://username:password@mongolab.com/linear
`

$3

Omitting either of these social networks will prevent it from showing up on the login screen.

#### Facebook

For more information on how to retrieve these keys see .

`
FACEBOOK_CLIENT_ID=
FACEBOOK_CLIENT_SECRET=
FACEBOOK_CALLBACK=http://localhost:5000/login/facebook/callback
`

#### Google

For more information on how to retrieve these keys see .

`
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK=http://localhost:5000/login/google/callback
`

#### Twitter

For more information on how to retrieve these keys see .

`
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_CALLBACK=http://localhost:5000/login/twitter/callback
`

The default template supports Twitter Cards. To get these to display you must first run a sample post through the Card Validator and then Request Approval to be whitelisted.

$3

Read more at .

`
SECRET=
``