mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00

History

James Allen d8804834ac Update README.md		2014-08-18 11:10:01 +01:00
..
cache	Configure CLSI to use sqllite	2014-02-18 17:40:23 +00:00
chef	Include build-essentials	2014-08-15 13:36:32 +01:00
config	Update default config to be more sane	2014-08-15 15:05:07 +01:00
package	Update upstart scripts	2014-08-18 10:46:42 +01:00
.gitignore	Update default config to be more sane	2014-08-15 15:05:07 +01:00
.nvmrc	Add .nvmrc	2014-02-25 16:02:23 +01:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2014-02-24 15:24:47 +00:00
Gruntfile.coffee	Update upstart scripts	2014-08-18 10:46:42 +01:00
LICENSE	Create LICENSE	2014-02-20 16:36:39 +00:00
package.json	Update default config to be more sane	2014-08-15 15:05:07 +01:00
README.md	Update README.md	2014-08-18 11:10:01 +01:00
Vagrantfile	Set up dev environment with Vagrant	2014-08-15 13:34:57 +01:00

README.md

ShareLaTeX

ShareLaTeX is an open-source online real-time collaborative LaTeX editor. We run a hosted version at http://www.sharelatex.com, but you can also run your own local version, and contribute to the development of ShareLaTeX.

Installation

We have detailed installation instructions in our wiki:

Please help us make ShareLaTeX as easy to install as possible by answering our quick survey about your system and needs

Dependencies

ShareLaTeX should run on OS X and Linux. You need:

Node.js 0.10 or greater. We recommend that you use nvm to install it.
The grunt command line tools (Run npm install -g grunt-cli to install them)
A local instance of Redis (version 2.6.12 or later) and MongoDB running on their standard ports.
TeXLive 2013 or later with the latexmk program installed.

Other repositories

This repository does not contain any code. It acts a wrapper and toolkit for managing the many different ShareLaTeX services. These each run as their own Node.js process and have their own Github repository. These are all downloaded and set up when you run grunt install

The different services are:

web

The front facing web server that serves all the HTML pages, CSS and JavaScript to the client. Also contains a lot of logic around creating and editing projects, and account management.

document-updater

Processes updates that come in from the editor when users modify documents. Ensures that the updates are applied in the right order, and that only one operation is modifying the document at a time. Also caches the documents in redis for very fast but persistent modifications.

CLSI

The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX documents.

docstore

An API for performing CRUD (Create, Read, Update and Delete) operations on text files stored in ShareLaTeX.

filestore

An API for performing CRUD (Create, Read, Update and Delete) operations on binary files (like images) stored in ShareLaTeX.

track-changes

An API for compressing and storing the updates applied to a document, and then rendering a diff of the changes between any two time points.

chat

The backend API for storing and fetching chat messages.

spelling

An API for running server-side spelling checking on ShareLaTeX documents.

Contributing

Please see the CONTRIBUTING file for information on contributing to the development of ShareLaTeX. See our wiki for information on setting up a development environment and how to recompile and run ShareLaTeX after modifications.

Authors

License

The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the LICENSE file.