Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A framework for node that supports HTTP and websocket requests.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
boilerplate
lib
test
.gitignore
.npmignore
LICENSE
Makefile
README.md
package.json

README.md

Gourdian

The simplest way to incorporate websockets into traditional web applications.

Installation

Gourdian is now set up to be installed as an npm module, but is not yet published. This means it can be installed in a few easy steps.

  • Install node 0.6.1
  • Install npm
  • git clone https://github.com/sonnym/gourdian.git && cd gourdian && npm link

Starting a Project

Once Gourdian is installed, staring a project is simple. Simply navigate to the folder you want to contain the project and type: gourdian init.

You can also specify a path, e.g. gourdian init path/to/project.

This directory will server as the root folder of your project. Initialization will create all the files necessary to begin working on a web application immediately.

Running a Server

The server is easily started by running: ./script/server.js

This will start the server with a REPL by default. To stop the server, simply type stop(); in the REPL.

Routes

Tests

Gourdian tests come in three different types:

  • Unit Tests
  • Integration Tests
  • Performance Tests

The main differences between the three can be summed up as the following:

Unit tests are the most basic case, upon which other types of test are built.

Integration tests provide you with an independent server and client for every test.

Performance tests give a flexible number of clients, but only one server for each test. They also have no timeout by default.

MVC

Gourdian object.

Included globally is the Gourdian object. At present, it contains the logger and a simple alias for deep inspection of objects.

Something went wrong with that request. Please try again.