Skip to content
This repository has been archived by the owner on Jan 10, 2022. It is now read-only.
Stu Salsbury edited this page Sep 30, 2013 · 12 revisions

Calipso

Calipso is a simple NodeJS content management system, built along similar themes to Drupal and Wordpress, that is designed to be fast, flexible and simple.

For additional details, including installation instructions, please visit the home page: http://calip.so/

If you would like to contribute, please take a look at the issues list as this will have the most up to date view of work that needs to be done for the next minor release. Otherwise, please just pm myself (cliftonc) or one of the other contributors on the main page and we can suggest some places for you to start.

Roadmap

0.3.0

Guide

The user guide and API is a work in progress, while it is in progress it will be located here as it is easy to keep it in sync with the development process. This will eventually be moved to Calip.so once it stabilises.

Core Development Approach

Ok, the general approach to development will be to use a single trunk to do devel (master), and then tag to do releases.

The initial early pre-alpha only run http://calip.so version is tagged as v0.1.0, with future releases (sort of) outlined as milestones in the issues list.

If you want to get involved, read the coding standards on calip.so, take a look at some of the existing modules or themes, grab the master branch, have a go, and send a pull request. If you have any questions please don't hesitate to ask - happy to help.

Development Steps

To get running in development mode (not the site mode outlined on the front page) - e.g. so you can make changes to core and submit pull requests:

  1. Fork the repository
  2. Clone from your fork (replace YOURNAME!): git clone git@github.com:YOURNAME/calipso.git
  3. Run 'npm install -d' in the clone folder to install all of the dependencies.
  4. Run 'node app' to run Calipso from the source folder.

Note that the bin/calipso script is really designed to allow people who just want to use Calipso to build sites to use it, it isn't used in the dev process. As always, any questions please do shout.

JSLint

I use the following command for JSLint

jslint --gp --node --nomen=false --onevar=false --indent=2 app.js

Mocha Testing

See the Testing page.