Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
c-spencer committed Mar 23, 2011
1 parent a8d9cd3 commit 2c36a86
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -6,14 +6,18 @@ This is the source code behind [notepag.es][0], a page site designed to allow qu

##Dependencies

Notepages is built upon [Node.js][1]/[MongoDB][2], and uses the [Grasshopper][3] and [Mongoose][4] libraries. Both libraries are available through `npm`. The server is expected to be run behind a webserver proxy (such as nginx), and for requests into the assets directory are served by the front end.
Notepages is built upon [Node.js][1]/[MongoDB][2], and uses the [Grasshopper][3] and [Mongoose][4] libraries. Both libraries are available through `npm`. Bundled libraries are [quickdiff][5] (created for notepages) and [grumble][6].

The server is expected to be run behind a webserver proxy (such as nginx), and for requests into the assets directory are served by the front end.

The database configuration is trivial and at the top of the `server.js` file. Running `node server.js` will start the server listening on port 8080.

[1]: http://nodejs.org
[2]: http://www.mongodb.org/
[3]: https://github.com/tuxychandru/grasshopper
[4]: https://github.com/LearnBoost/mongoose
[5]: https://github.com/c-spencer/quickdiff
[6]: http://plugins.jquery.com/project/grumble

### Sample nginx configuration

Expand Down

0 comments on commit 2c36a86

Please sign in to comment.