Starter template for BlueOak Server projects

You can clone this repository or download the zip file to get a head start on a new BlueOak Server-based project.

Clone and customize example

Here are some steps you could take from a *nix shell to get the project and make it your own:

git clone --depth 1 git@github.com:BlueOakJS/blueoak-server-template.git my-new-project
cd my-new-project
rm -fr .git/
git init

At this point, you'll want to update the package.json file to change the name, description, repository, and (perhaps) license fields, e.g.:

{
    "name": "my-new-project",
    "version": "1.0.0",
    "description": "Something for the weekend, sir?",
		"repository": {
			"type": "git",
			"url": "git@github.com:seanpk/my-new-project.git"
		},
    "license": "SEE LICENSE IN LICENSE",
    "scripts": {
        "start": "blueoak-server || npm run postinstall",
        "lint": "eslint --ignore-pattern node_modules **/*.js",
        "test": "mocha --check-leaks --globals services,__appDir test/unit; npm run lint"
    },
    "dependencies": {
        "blueoak-server": "^2.8.0"
    },
    "devDependencies": {
        "eslint": "^3.14.1",
        "eslint-config-defaults": "^9.0.0",
        "mocha": "^3.2.0"
    }
}

Install the project dependencies with npm install, and then run the server with one of npm start or nodemon.

More information

For details on using BlueOak Server, check out the wiki.