File tree 1 file changed +9
-3
lines changed
1 file changed +9
-3
lines changed Original file line number Diff line number Diff line change @@ -7,17 +7,19 @@ A seed project for building out a new api. Supports resource-based routing, Seq
7
7
* [ Dependencies] ( #dependencies )
8
8
* [ Signals] ( #signals )
9
9
* [ Migrations] ( #migrations )
10
+ * [ Docs] ( #docs )
10
11
11
12
12
13
## Getting Started
13
- - nvm install 0.10.22
14
- - npm install -g mocha
14
+ - nvm install 0.10.26
15
+ - npm install -g mocha grunt-cli
15
16
- npm install
16
17
- edit /conf/development.js && /conf/test.js database information appropriately
17
18
- createdb api_dev ; createdb api_test
18
19
- nvm use
19
20
- npm test
20
21
- npm start
22
+ - optionally, run 'grunt watch' for [ JSHint] [ jshint ] results on saves
21
23
22
24
### Dependencies
23
25
- [ Node.js ≥ 0.10.22] [ node ]
@@ -46,9 +48,13 @@ Api Starter uses [Sequelize's][sequelize] built in migration support. [Docs her
46
48
47
49
** IMPORTANT** do * NOT* use the global sequelize binary ie) ` sequelize -m ` . Use the binary installed locally to the node_modules folder.
48
50
51
+ ### Docs
52
+ The default grunt task generates documentation using [ APIDoc] [ apidoc ] .
49
53
50
54
[ node ] : http://nodejs.org/ " Node.js "
51
55
[ cluster ] : http://nodejs.org/docs/v0.10.22/api/cluster.html " Cluster - Node v0.10.22 "
52
56
[ redis ] : http://redis.io/download " Redis "
53
57
[ postgres ] : http://www.postgresql.org/ " Postgres "
54
- [ sequelize ] : http://http://sequelizejs.com/ " Sequelize "
58
+ [ sequelize ] : http://http://sequelizejs.com/ " Sequelize "
59
+ [ jshint ] : http://www.jshint.com/docs/ " JSHint "
60
+ [ apidoc ] : http://apidocjs.com/ " APIDocJS "
You can’t perform that action at this time.
0 commit comments