https://github.com/blueoakjs/blueoak-server-template

Use this package as a template to create your own BlueOak Server-base project.
https://github.com/blueoakjs/blueoak-server-template

Last synced: about 2 months ago
JSON representation

Use this package as a template to create your own BlueOak Server-base project.

• Host: GitHub
• URL: https://github.com/blueoakjs/blueoak-server-template
• Owner: BlueOakJS
• License: mit
• Created: 2016-02-02T16:11:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-02-03T04:07:17.000Z (over 9 years ago)
• Last Synced: 2025-12-26T11:43:18.291Z (5 months ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 4
• Watchers: 14
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Starter template for BlueOak Server projects

You can [clone this repository][https-clone] or [download the zip file][dl-master] 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:

```sh

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.:

```json

{

    "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][bos-wiki].

[bos-wiki]: https://github.com/BlueOakJS/blueoak-server/wiki

[dl-master]: https://github.com/BlueOakJS/blueoak-server-template/archive/master.zip

[https-clone]: https://github.com/BlueOakJS/blueoak-server-template.git