Live preview
escrito.herokuapp.com (also available at the Chrome Web Store)
Installation and Usage
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:
- NodeJS - Evented I/O for V8 JavaScript
- ShareJS - The collaborative editing engine by Joseph Gentle
- Ace Editor - Textarea enriched by Mozilla
- Markdown mode - Support added by Chris Spencer
- Showdown - Markdown parser made by John Fraser
- Textile parser - Textile parser made by Ben Daglish
- Google Caja - HTML Sanitizer
Check them all in the humans.txt file.