UNPKG

linear

Version:

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

github.com/trylinear/linear

trylinear/linear

112 lines (72 loc) • 3.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# linear > A simple setup micro-forum built in Node.js with Express and MongoDB. [![Build Status](https://travis-ci.org/trylinear/linear.svg)](https://travis-ci.org/trylinear/linear) [![codecov](https://img.shields.io/codecov/c/github/trylinear/linear/master.svg)](https://codecov.io/gh/trylinear/linear) [![Dependency Status](https://david-dm.org/trylinear/linear.svg?style=flat)](https://david-dm.org/trylinear/linear/) [![Known Vulnerabilities](https://snyk.io/test/npm/linear/badge.svg)](https://snyk.io/test/npm/linear) [![bitHound Overall Score](https://www.bithound.io/github/trylinear/linear/badges/score.svg)](https://www.bithound.io/github/trylinear/linear) [![NPM Version](http://img.shields.io/npm/v/linear.svg?style=flat)](https://www.npmjs.org/package/linear/) ## Install ```bash $ npm install linear --save ``` ## Quick Start ```javascript const linear = require('linear'); linear.startWithConfig({ 'site_name': 'Sample Forum' }); ``` ## Config ### site_name Type: `String` Default: `'Sample Forum'` Name used in both `header` and `title` tags throughout the site. ### directories 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. ### ga Type: `String` Default: `''` Tracking code for Google Analytics. <http://www.google.com/analytics/> ## Environment Setup Place the following key/value pairs in an `.env` file locally and within the settings panel of your Heroku application. ### Setting Up MongoDB Read more at <https://devcenter.heroku.com/articles/nodejs-mongoose#mongodb-connectors>. ``` MONGOLAB_URI=mongodb://username:password@mongolab.com/linear ``` ### Setting Up Social Networks 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 <https://github.com/trylinear/linear/wiki/Social-Setup#facebook>. ``` FACEBOOK_CLIENT_ID=<token> FACEBOOK_CLIENT_SECRET=<token> FACEBOOK_CALLBACK=http://localhost:5000/login/facebook/callback ``` #### Google For more information on how to retrieve these keys see <https://github.com/trylinear/linear/wiki/Social-Setup#google>. ``` GOOGLE_CLIENT_ID=<token> GOOGLE_CLIENT_SECRET=<token> GOOGLE_CALLBACK=http://localhost:5000/login/google/callback ``` #### Twitter For more information on how to retrieve these keys see <https://github.com/trylinear/linear/wiki/Social-Setup#twitter>. ``` TWITTER_CONSUMER_KEY=<token> TWITTER_CONSUMER_SECRET=<token> TWITTER_CALLBACK=http://localhost:5000/login/twitter/callback ``` The default template supports [Twitter Cards](https://dev.twitter.com/cards/overview). To get these to display you must first run a sample post through the [Card Validator](https://cards-dev.twitter.com/validator) and then **Request Approval** to be whitelisted. ### Setting Up Express Session Security Read more at <https://github.com/expressjs/session#sessionoptions>. ``` SECRET=<token> ```