Skip to content

Commit

Permalink
working on readme [see #2]
Browse files Browse the repository at this point in the history
  • Loading branch information
kbjr committed Sep 5, 2013
1 parent 62a2cc1 commit 12e7d9f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,19 @@ project
| +--production.js
+--models
+--routes
+--start.js
```

The `config` directory contains a master config file with all of your default configuration, and another config file with overrides for each environment you plan to use. The `models` directory contains your models, which are used to automatically build the API endpoints. The `routes` directory is optional, and can contain "resources" which allow you to build custom endpoints not directly tied to a model.

Starting up the project is easy. Your start.js file should look something like this:

###### ./start.js

```javascript
require('dagger.js').initialize(__dirname);
```

### Models

Models are designed using a beefed up [mongoose](http://mongoosejs.com/) system. A basic model in Dagger looks something like this:
Expand Down

0 comments on commit 12e7d9f

Please sign in to comment.