Skip to content

Commit

Permalink
updated REAME
Browse files Browse the repository at this point in the history
  • Loading branch information
stowns committed Jul 13, 2014
1 parent fd97390 commit f1c4de1
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@ A seed project for building out a new api. Supports resource-based routing, Seq
* [Dependencies](#dependencies)
* [Signals](#signals)
* [Migrations](#migrations)
* [Docs](#docs)


## Getting Started
- nvm install 0.10.22
- npm install -g mocha
- nvm install 0.10.26
- npm install -g mocha grunt-cli
- npm install
- edit /conf/development.js && /conf/test.js database information appropriately
- createdb api_dev ; createdb api_test
- nvm use
- npm test
- npm start
- optionally, run 'grunt watch' for [JSHint][jshint] results on saves

### Dependencies
- [Node.js ≥ 0.10.22][node]
Expand Down Expand Up @@ -46,9 +48,13 @@ Api Starter uses [Sequelize's][sequelize] built in migration support. [Docs her

**IMPORTANT** do *NOT* use the global sequelize binary ie) `sequelize -m`. Use the binary installed locally to the node_modules folder.

### Docs
The default grunt task generates documentation using [APIDoc][apidoc].

[node]: http://nodejs.org/ "Node.js"
[cluster]: http://nodejs.org/docs/v0.10.22/api/cluster.html "Cluster - Node v0.10.22"
[redis]: http://redis.io/download "Redis"
[postgres]: http://www.postgresql.org/ "Postgres"
[sequelize]: http://http://sequelizejs.com/ "Sequelize"
[sequelize]: http://http://sequelizejs.com/ "Sequelize"
[jshint]: http://www.jshint.com/docs/ "JSHint"
[apidoc]: http://apidocjs.com/ "APIDocJS"

0 comments on commit f1c4de1

Please sign in to comment.