# node-flarum

> The Flarum forum with NodeJS

Latest version **0.0.1-beta.4** (published 2016-02-20) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-flarum
pnpm add node-flarum
yarn add node-flarum
bun add node-flarum
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.1-beta.4 |
| Published | 2016-02-20 |
| First published | 2016-02-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+19 in 7 direct dependencies) |
| Install scripts | no |
| GitHub stars | 20 |
| Author | David Sevilla Martín |
| Maintainers | datitisev |
| Keywords | flarum, nodejs, node, mongo, mongodb, forum |

## Links

- npm: https://www.npmjs.com/package/node-flarum
- Repository: https://github.com/datitisev/node-flarum
- Homepage: https://github.com/datitisev/node-flarum#readme
- Issues: https://github.com/datitisev/node-flarum/issues
- npm.io page: https://npm.io/package/node-flarum

## Dependencies (12)

- [hbs](https://npm.io/package/hbs.md) 4.0.0
- [debug](https://npm.io/package/debug.md) 2.2.0
- [morgan](https://npm.io/package/morgan.md) 1.6.1
- [express](https://npm.io/package/express.md) 4.13.4
- [shortid](https://npm.io/package/shortid.md) 2.2.4
- [mongoose](https://npm.io/package/mongoose.md) 4.3.7
- [passport](https://npm.io/package/passport.md) 0.3.2
- [body-parser](https://npm.io/package/body-parser.md) 1.14.2
- [bcrypt-nodejs](https://npm.io/package/bcrypt-nodejs.md) 0.0.3
- [cookie-parser](https://npm.io/package/cookie-parser.md) 1.4.1
- [serve-favicon](https://npm.io/package/serve-favicon.md) 2.3.0
- [passport-local](https://npm.io/package/passport-local.md) 1.0.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.0.1-beta.4 (latest) — 2016-02-20
- 0.0.1-beta.3 — 2016-02-20
- 0.0.1-beta.2 — 2016-02-20
- 0.0.1-beta.1 — 2016-02-18

## README

# node-flarum


[![Build Status](https://travis-ci.org/datitisev/node-flarum.svg?branch=master)](https://travis-ci.org/datitisev/node-flarum) [![GitHub version](https://badge.fury.io/gh/datitisev%2Fnode-flarum.svg)](https://badge.fury.io/gh/datitisev%2Fnode-flarum) [![NPM version](https://badge.fury.io/js/node-flarum.svg)](https://badge.fury.io/js/node-flarum)

A forum made out of [Flarum](http://flarum.org)'s design forum with NodeJS

## Installation

```sh
npm install node-flarum --save
```

## Usage

### HTTP

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

```node
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

```node
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
```



## 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](https://github.com/datitisev/node-flarum/releases/tag/v0.0.2))

---
_Source: https://npm.io/package/node-flarum · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._