Incense NPM | npm.io

node-incense

Discussion Board UI.

Install

$ npm install --save incense

incense requires biflora, and socket.io.

$ npm install --save biflora
$ npm install --save socket.io

Usage

Server side

var express = require('express'),
	app = express();
var server = require('http').Server(app);
var biflora = require('biflora');
var Incense = require('incense'),
	incense = new Incense({
		'dataDir': '/path/to/datadir/', // <- data directory (Read/Write permission required)
		'db': { // <- database setting
			"dbms": "sqlite",
			"storage": "/path/to/your/database.sqlite",
			"tablePrefix": "incense"
		} ,
		'getUserInfo': function( socket, clientDefaultUserInfo, callback ){
			// provide user info.
			// e.g. {
			//     'id': 'user_id',
			//     'name': 'User Name',
			//     'url': 'http://example.com/',
			//     'icon': 'http://example.com/sample.png'
			// }
			callback(clientDefaultUserInfo);
			return;
		}
	});


// middleware - biflora resources
app.use( biflora.clientLibs() );
biflora.setupWebSocket(
	server,
	incense.getBifloraApi() ,
	incense.getBifloraMain()
);

// middleware - Incense API for Express
app.use( '/path/to/incense/api', incense.getExpressMiddleware() );

// middleware - frontend documents
app.use( express.static( '/path/to/htdocs/' ) );

server.listen( 3000, function(){
	console.log('message: server-standby');
} );

MySQLを利用する場合は次のように書きます。

var db_host = "your.dbhost",
	db_database = "your_scheme_name",
	db_user = "mysql_user_name",
	db_password = "mysql_password";

incense = new Incense({
	'dataDir': ......,
	'db': {
		"dbms": "mysql",
		"host": db_host,
		"database": db_database,
		"user": db_user,
		"password": db_password,
		"tablePrefix": "incense"
	} ,
	'getUserInfo': ......
});

Client side

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8" />
		<title>passiful/incense</title>

		<!-- incense -->
		<link rel="stylesheet" href="./common/dist/incense.css" />
	</head>
	<body>
		<h1>passiful/incense</h1>
		<div class="test-wrap">
			<div id="testBoardElement"></div>
			<div id="testTimelineElement"></div>
		</div>

		<!-- socket.io -->
		<script src="/socket.io/socket.io.js" type="text/javascript"></script>

		<!-- biflora -->
		<script src="/biflora/biflora.js" type="text/javascript"></script>

		<!-- incense -->
		<script src="./common/dist/incense.js" type="text/javascript"></script>

		<!-- initialize code -->
		<script>
			window.incense = new Incense();
			incense.init(
				{
					'elmBoard': document.getElementById('testBoardElement'),
					'elmTimeline': document.getElementById('testTimelineElement'),
					'boardId': 1234567890, // <- discussion board name
					'apiUrl': window.location.origin+'/path/to/incense/api', // <- URL of Incense API Express Middleware
					'userInfo': {
						'id': 'tester', // <- login user id
						'name': 'Test User', // <- login user name
						'url': 'https://example.com/', // <- login user profile page
						'icon': 'https://example.com/sample.png' // <- login user icon
					}
				},
				function(){
					console.log('incense standby.');
				}
			);
		</script>
	</body>
</html>