A framework for writing modular web applications in node.js
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.
To install through npm, run the following command in your terminal of choice:
npm install jimi
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:
Then visit http://127.0.0.1:8009/ in your web browser.
Example App Structure
<app_directory> | |- app.js |- urls.js |- views.js | |- <module_directory> | | | |- urls.js | |- views.js | |- <public_directory> | | | |- <public_file>.css | |- 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. Public content such as static files should be placed in a folder inside your app directory. Look at either of the examples to see how they fit in.
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 email@example.com.
jimi was originally based on djangode, a node.js micro-framework written by Simon Willison. The framework still uses the djangode templating system, so he deserves heaps of credit.