node-flarum

A forum made out of Flarum's design forum with NodeJS

---

Installation

NPM

npm install node-flarum --save

Latest Stable Release

npm install git+https://github.com/FlarumJS/node-flarum.git --save

Latest Release

npm install git+https://github.com/FlarumJS/node-flarum.git#develop

Usage

HTTP

Using the http package required the following modules to be installed: connect & connect-hopeful-body-parser

var http = require('http');
var connect = require('connect');
var bodyParser = require('connect-hopeful-body-parser');

var flarum = require('./index');

var app = connect();

app.use(bodyParser());
app.use(flarum); // You can only have flarum in root path, otherwise won't work

http.createServer(app).listen(8080);

Express

var flarum = require('node-flarum');

var express = require('express');
var app = express();

// Other stuff

app.use('/forum', flarum) // This will execute flarum on the "/forum" path
app.use(flarum)           // This will execute flarum on the root path

---

Inline Docs

Online

Visit the FlarumJS Inline Docs

Offline / Locally

Install jsdoc by typing npm install jsdoc inside the node-flarum package folder. After installing jsdoc execute jsdoc -t ./node_modules/ink-docstrap/template -c docs.config.json -R README.md -r . -d ./docs in the project root and then open docs/index.html in your web browser

Contributing

Whenever this forum is complete [•••], there will be a website here for the official NodeJS Flarum forum

---

Release History

• v0.0.1 - NPM Package Information
• v0.0.2 - Added Configuration Tweaks, fixed links and mongodb problems (Full Release Information)
• v0.0.3 - Added Sign Up & Log In Options; Added inline documentation for the package (Full Release Information)
• v0.0.4 - Added Github Login; Added Ability to Create Discussions; Updated Schemas for the better; Etc... (Full Release Information)