https://github.com/deployable/node-express-api-template

Express 4 API Template
https://github.com/deployable/node-express-api-template

Last synced: 12 months ago
JSON representation

Express 4 API Template

• Host: GitHub
• URL: https://github.com/deployable/node-express-api-template
• Owner: deployable
• Created: 2015-10-18T11:01:25.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-10-25T23:02:10.000Z (over 10 years ago)
• Last Synced: 2025-02-09T20:27:47.364Z (about 1 year ago)
• Language: CoffeeScript
• Size: 215 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Express API Template

An express based http api template

To install from `git`

    git clone https://github.com/deployable/node-express-api-template#current

## Running the app

    node app.js

### Running the coffescript app for development

The coffee script source can be run directly if you have the source from git

    node appcoffee.js

## App config

The application config file is in `app/config.json`

 - `http.port` The port the server listens on

 - `http.address` The address the server listens on

### Git app config

From `git`, the application only comes with a default config file `app/config.json.default`

This needs to be copied to `app/config.json` as your local running config. Your running config will not be checked back into git. 

    $ cp app/config.json.default app/config.json

    $ vi app/config.json

## Test

`mocha` and `superagent` are used to test the api. 

Tests are written in coffeescript.