Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Collaborative writing with Markdown & Textile
JavaScript CoffeeScript
Tree: e9d9e0c170

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
editor
public
Cakefile
LICENSE
Procfile
README.md
package.json
web.coffee

README.md

escrito logo

Demonstration

http://escrito.herokuapp.com/

Installation

First make sure you have a working copy of Node.js and npm (the node package manager).

To install escrito you'll need coffee.

npm install -g coffee-script

Check if everything went okay.

coffee -v

Next, run (this may take a while):

npm install -g escrito

Then start the server.

escrito

That should be enough!

You can pass custom arguments:

escrito --port 4567

Documents are not persistent by default but you can set a custom database type.

The available options are 'memory' and 'redis'. Those are the database types supported by the ShareJS project.

escrito --database redis

For more detailed help type:

escrito -h

Local installation

You can also install escrito locally. This will install it in your current directory.

npm install escrito

Start the server:

npm start escrito

To pass custom arguments using npm, you have to use a slightly different syntax.

For example, to set up the server with a custom port you should do the following:

npm config set escrito:port 5000

From source

You can clone the github repository.

git clone git://github.com/dmfrancisco/escrito.git

Install all the dependencies.

cd escrito
npm install

Run the server:

coffee web.coffee

Again, you can pass custom arguments.

coffee web.coffee --port 4567 --database redis

Compiling CoffeeScripts

If you want to compile the CoffeeScripts to JavaScript.

cake build-dependencies
cake build

Run the server:

node web.js

This wouldn't be possible without Open Source projects like

Check them all in the humans.txt file.

Something went wrong with that request. Please try again.