Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

MongoDB backed Dictionary

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 app
Octocat-spinner-32 etc
Octocat-spinner-32 public
Octocat-spinner-32 test
Octocat-spinner-32 views
Octocat-spinner-32 .gitignore
Octocat-spinner-32 App.coffee
Octocat-spinner-32 Cakefile
Octocat-spinner-32 Procfile
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
README.md

CoffeeScript - Mongoose - MongoDB dictionary app

This project is a Node web app (using Express) that leverages MongoDB for a datastore. The source code is CoffeeScript. ORM is facilitated by Mongoose, which is a Mongoid-like framework (if you are coming from the Ruby community) in that it allows you to create model objects that represent documents. The API is fairly straightforward; if you're familiar with native Mongo query semantics then you'll pick up Mongoose quickly. For more information and examples of Mongoose, check out the tests in the test directory of this project.

Installation

Make sure you are on a current version of Node and have CoffeeScript installed. First grab all the required dependencies via npm install and then type coffee app/App.coffee.

Note, to connect to a valid instance of Mongo, you'll need a username and password; what's more, you'll need to export them so that the process can read them at runtime like so:

$>export MONGO_USER=...
$>export MONGO_PASSWORD=...

Running the tests

This project uses Mocha and should -- to run these tests, type cake test.

Note, the tests assume you have Mongo running locally.

Helpful resources

Tools, libraries, and things to checkout

License

The MIT License

Copyright (c) 2011 Andrew Glover

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

Something went wrong with that request. Please try again.