liudada / camus.treehole

Caμs Tree-hole Project

Caμs Tree-hole Project

Directory/File	Description	Content
routes/	Controllers and routers
views/	Templates based on Swig
public/	static files (js, css, img)
config/	Middlewares	All configuration files
test/	Test units	*.spec.js
app.js	Entry point (create express server)
Gruntfile.js	Makefile

Development Guide

Preperation

First install Node.js and then run

$ npm install
$ bower install

Second install MongoDB

Test

Test your code.

$ grunt

Preview

$ grunt serve

Code Format

Please install plugin "editorconfig" to your code editor first EditorConfig

Guide

Use config/db's db() method to get an instance of db

var db = require('../config/db').db();
app.route('/test', function(req, res) {
  db.collection('holes').find().toArray(function(err, result) {
    res.status(200).send(result);
  });
});

MongoDB API Documentation

WebStorm Setup Guide

0. Choose Open..., and select the project root.
1. From Run->Edit Configuration, click add new configuration and choose Node.js.
2. Type app.js in Javascript file, click ... of Environment settings, add PORT=9000 and NODE_ENV=development. Click apply.
3. Again click add new configuration and choose mocha. Add environment variables NODE_ENV=test. Click apply.

** Notes **: you need to run an extern MongoDB service to get this work.

WebStorm