libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
187 commits 2 branches 0 tags 24 MiB
JavaScript 91.5%
CSS 3.6%
HTML 3.5%
Shell 1.2%
Dockerfile 0.1%
Find a file
Peter 'Pita' Martischka 80a478fd55 Change everything to the new Socket.IO API
2011-06-23 14:08:18 +01:00
bin Change 'npm link' to 'npm install'. It does the same but doesn't need root permissions and it's able to check which dependencies are already installed 2011-06-23 11:34:57 +01:00
doc Beautify the docs 2011-05-30 16:05:42 +01:00
node Change everything to the new Socket.IO API 2011-06-23 14:08:18 +01:00
static update to socket.io 0.7.2 2011-06-23 12:33:31 +01:00
tests added Pad model via Joose, PadManager is a lot cleaner now. 2011-05-16 16:30:21 +02:00
var Minify and compress JS & CSS before sending it 2011-05-28 18:09:17 +01:00
.gitignore Create a template of the settings file 2011-06-02 12:15:02 +01:00
.npmignore Added a .npmignore for smaller npm packages 2011-05-19 13:17:24 +01:00
package.json update to socket.io 0.7.2 2011-06-23 12:33:31 +01:00
README.md Change 'npm link' to 'npm install'. It does the same but doesn't need root permissions and it's able to check which dependencies are already installed 2011-06-23 11:34:57 +01:00
settings.json.template Create a template of the settings file 2011-06-02 12:15:02 +01:00

README.md

About

Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad. We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite is based on node.js what makes it much leigther and more stable than the original Etherpad. Our hope is that this will encourage more users to install a realtime collaborative editor. A smaller and well documented codebase makes it easier for developers to improve the code

Online demo
Visit http://pitapoison.de:9001 to test it live

Why use Etherpad Lite?

  • Tiny server hardware footprint
  • Pure Javascript client and server side
  • Simplfied interface
  • Easy to embed
  • Well documented

Installation

  1. Download latest node.js version from http://nodejs.org/ and build it with this instructions https://github.com/joyent/node/wiki/Installation.
    THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION.
  2. Install npm curl http://npmjs.org/install.sh | sh
  3. Ensure you have installed the sqlite develob libraries, gzip and git apt-get install libsqlite3-dev gzip git-core
  4. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
  5. Install the dependencies cd etherpad-lite && npm install
  6. Start it with bin/run.sh
  7. Open your web browser and visit http://localhost:9001

Next Steps

You can modify the settings in the file settings.json

You can update to the latest version with git pull origin && npm install

You can debug with bin/runDebug.sh

Develop

If you're new to git and github, start here http://learn.github.com/p/intro.html.

If you're new to node.js, start with this video http://youtu.be/jo_B4LTHi3I.

If you wanna find out how Etherpads Easysync works (the library that makes it realy realtime), start with this PDF (complex, but worth reading it).

You know all this and just want to know how you can help? Look at the TODO list. You can join the mailinglist or go to the freenode irc channel #etherpad-lite-dev

You also help the project, if you only host a ep-lite instance and share your experience with us.

License

Apache License v2