2014-02-12 06:24:13 -05:00
ShareLaTeX
==========
2014-08-18 06:10:01 -04:00
[ShareLaTeX ](https://www.sharelatex.com ) 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.
2014-02-21 05:18:33 -05:00
Installation
------------
2014-02-08 14:40:56 -05:00
2014-08-18 06:10:01 -04:00
We have detailed installation instructions in our wiki:
2014-02-22 07:08:03 -05:00
2014-08-18 06:10:01 -04:00
* [Installing ShareLaTeX in Production ](https://github.com/sharelatex/sharelatex/wiki/Production-Installation-Instructions )
* [Setting up a ShareLaTeX Development Environment ](https://github.com/sharelatex/sharelatex/wiki/Setting-up-a-Development-Environment )
2014-02-22 07:08:03 -05:00
2014-08-19 12:07:18 -04:00
**If you have any problems, have a look at our page of [Frequent Problems and Questions ](https://github.com/sharelatex/sharelatex/wiki/FAQ ).**
*[Please help us make ShareLaTeX as easy to install as possible by answering our quick survey about your system and needs](https://sharelatex.typeform.com/to/PLNits)*
2014-03-06 05:12:53 -05:00
2014-02-08 14:40:56 -05:00
Dependencies
2014-02-12 06:24:13 -05:00
------------
2014-02-19 10:37:47 -05:00
ShareLaTeX should run on OS X and Linux. You need:
2014-02-08 14:40:56 -05:00
2014-02-25 06:27:27 -05:00
* [Node.js ](http://nodejs.org/ ) 0.10 or greater. We recommend that you use [nvm ](https://github.com/creationix/nvm ) to install it.
2014-02-19 10:37:47 -05:00
* The [grunt ](http://gruntjs.com/ ) command line tools (Run `npm install -g grunt-cli` to install them)
2014-04-09 05:56:00 -04:00
* A local instance of [Redis ](http://redis.io/topics/quickstart ) (version 2.6.12 or later) and [MongoDB ](http://docs.mongodb.org/manual/installation/ ) running on their standard ports.
2014-02-25 10:38:41 -05:00
* [TeXLive ](https://www.tug.org/texlive/ ) 2013 or later with the `latexmk` program installed.
2014-02-08 14:40:56 -05:00
Other repositories
2014-02-12 06:24:13 -05:00
------------------
2014-02-08 14:40:56 -05:00
2014-08-18 06:10:01 -04:00
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`
2014-02-08 14:40:56 -05:00
The different services are:
2014-02-24 09:44:35 -05:00
### [web](https://github.com/sharelatex/web-sharelatex) [](https://travis-ci.org/sharelatex/web-sharelatex)
2014-02-08 14:40:56 -05:00
2014-02-21 09:00:12 -05:00
The front facing web server that serves all the HTML pages, CSS and JavaScript
2014-02-08 14:40:56 -05:00
to the client. Also contains a lot of logic around creating and editing
projects, and account management.
2014-02-24 09:44:35 -05:00
### [document-updater](https://github.com/sharelatex/document-updater-sharelatex) [](https://travis-ci.org/sharelatex/document-updater-sharelatex)
2014-02-08 14:40:56 -05:00
2014-02-18 11:28:24 -05:00
Processes updates that come in from the editor when users modify documents. Ensures that
2014-02-08 14:40:56 -05:00
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.
2014-02-24 09:44:35 -05:00
### [CLSI](https://github.com/sharelatex/clsi-sharelatex) [](https://travis-ci.org/sharelatex/clsi-sharelatex)
2014-02-13 08:07:03 -05:00
The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX
documents.
2014-08-15 06:16:38 -04:00
### [docstore](https://github.com/sharelatex/docstore-sharelatex) [](https://travis-ci.org/sharelatex/docstore-sharelatex)
An API for performing CRUD (Create, Read, Update and Delete) operations on text files
stored in ShareLaTeX.
2014-02-24 09:44:35 -05:00
### [filestore](https://github.com/sharelatex/filestore-sharelatex) [](https://travis-ci.org/sharelatex/filestore-sharelatex)
2014-02-18 11:28:24 -05:00
2014-02-21 09:00:12 -05:00
An API for performing CRUD (Create, Read, Update and Delete) operations on binary files
2014-02-18 11:28:24 -05:00
(like images) stored in ShareLaTeX.
2014-03-05 08:39:21 -05:00
### [track-changes](https://github.com/sharelatex/track-changes-sharelatex) [](https://travis-ci.org/sharelatex/track-changes-sharelatex)
An API for compressing and storing the updates applied to a document, and then rendering a diff of the changes
2014-08-15 06:15:05 -04:00
between any two time points.
### [chat](https://github.com/sharelatex/chat-sharelatex) [](https://travis-ci.org/sharelatex/chat-sharelatex)
The backend API for storing and fetching chat messages.
2014-03-05 08:39:21 -05:00
2014-08-15 07:02:22 -04:00
### [tags](https://github.com/sharelatex/tags-sharelatex) [](https://travis-ci.org/sharelatex/tags-sharelatex)
The backend API for managing project tags (folders).
2014-08-15 07:39:55 -04:00
### [spelling](https://github.com/sharelatex/spelling-sharelatex)
An API for running server-side spelling checking on ShareLaTeX documents.
2014-08-15 07:02:22 -04:00
2014-02-13 08:07:03 -05:00
Contributing
------------
2014-02-23 16:37:07 -05:00
Please see the [CONTRIBUTING ](https://github.com/sharelatex/sharelatex/blob/master/CONTRIBUTING.md ) file for information on contributing to the development of ShareLaTeX. See [our wiki ](https://github.com/sharelatex/sharelatex/wiki/Developer-Guidelines ) for information on setting up a development environment and how to recompile and run ShareLaTeX after modifications.
2014-02-08 14:40:56 -05:00
2014-02-17 15:01:21 -05:00
Authors
---
2014-02-18 11:28:24 -05:00
- [Henry Oswald ](http://twitter.com/henryoswald )
- [James Allen ](http://twitter.com/thejpallen )
2014-02-20 11:37:34 -05:00
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.
Copyright (c) ShareLaTeX, 2014.
