Commits

remosu committed 5b442bc

draft of README content

Comments (0)

Files changed (1)

-=========
-BackMongo
-=========
+## BackMongo
 
+###Description
+It's a simple MongoDB REST service written in Python that can be used straight away from a Backbone application.
+It's an alpha version.
+We are using it to develop backbone apps without having to worry about the server side. We've coded what we've needed so far. In the future we plan to add more features, such as, authentication, user privileges, etc.
+At the moment backmongo can be only used as a flask extension, but we plan to add extensions from other frameworks.
 
+###Requirements
+flask, pymongo
 
+###Examples
+There's an example in examples/todos/ (a slightly modified version of this todo example __link__) that illustrates how easy it's to use backmongo from a backbone application.
+
+###Tests
+There are several integration tests coded in javascript using Mocha running on Node.
+We wrote to posts about how to troubleshoot several problems we came across while setting the tests environment:
+ - link 1
+ - link 2
+
+ To execute the tests you need to install first bla, bla.
+
+ Then you have to start a flask server by executing:
+ bla, bla from bla, bla directory
+ Finally, the tests are run executing a make file:
+ bla, bla  from bla, bla directory
+
+
+
+
+
+
+
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.