Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A framework for writing modular web applications in node.js
JavaScript CSS
Tag: v0.0.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
apps
docs
lib
.gitignore
README.md
package.json

README.md

jimi

This web framework is based on Simon Willison's djangode, a node.js project inspired by django.

About jimi

Apps contain a set of (regex) URL patterns that map HTTP requests to handler methods, called views. URL patterns and views are stored in separate files, which are imported when the app is executed. Apps can be organised into a set of modules, each with their own URL and view definitions. You can build quite complex apps by hooking a module's URL patterns one of the parent module's URL patterns (in the same way that django does).

Djangode currently implements a javascript conversion of the django template system, which has been modified slightly to work with more recent versions of node.js. The template system can be hooked into your views to provide a simpler way to render your content.

To use jimi & run the example apps you must have node.js and npm installed.

Installation

To install through npm, run the following command in your terminal of choice:

npm install jimi

Example Apps

Examples are be stored in the apps directory, and will give you a starting point for building your applications. Navigate to the example directory and run:

node app.js

Then visit http://127.0.0.1:8009/ in your web browser.

Fork the project, have a play around, and please contribute!

App Structure

<app_directory>
 |
 |- app.js
 |- urls.js
 |- views.js
 |
 |- <module_directory>
 |   |
 |   |- urls.js
 |   |- views.js
 |
 |- templates
     |
     |- <base_template>.html
     |
     |- <module_directory>
         |
         |- <template>.html
         |- <template>.html

Templates don't have to be laid out this way, but the templating example uses this layout. Also, this structure doesn't show static content. This would be placed in a sub folder of the app directory. Look at either of the examples to see how they fit in.

In Development...

  • I'm currently looking into using Connect as a middleware layer between jimi and node.js, which will result in a rewrite that strips out most of the original djangode code.

  • I'm considering replacing the templating system with something more lightweight as a one-to-one copy of the django templating system may not be the best way forward. This may not happen straight away though.

  • I'm also considering various node.js data modelling libraries for building the 'model' layer of jimi, so please forward any suggestions to colin.j.gourlay@gmail.com.

Thanks

This project wouldn't be possible without Simon Willison, who's enthusiasm for bleeding edge web technology regularly spawns cool projects such as djangode. The source code for jimi is heavily based on djangode, and will hopefully evolve along the lines that Simon intended it to. The django project also deserves heaps of credit. jimi is an exploration of django's concepts in the world of server-side JavaScript, so thanks to the django community for doing the real heavy lifting.

Something went wrong with that request. Please try again.