github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
James Allen 2014-02-13 13:07:03 +00:00
parent d02c777e55
commit 3492e118fd
1 changed files with 29 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,12 +1,14 @@
ShareLaTeX
==========
ShareLaTeX is a web based collaborative LaTeX editor. There are two versions of it,
the online version that anyone can sign up to at www.sharelatex.com, and this open source
version which allows anyone to run a local installation of ShareLaTeX.
ShareLaTeX is a web-based collaborative LaTeX editor. We run a hosted service at
https://www.sharelatex.com and this repository contains the open source code that
powers it and allows you to run a local installation.
This repository pulls together all of the different services in ShareLaTeX's service
orientied architecture (SOA).
ShareLaTeX uses a service orientied architecture (SOA) where we have lots of small
APIs that talk to each other over HTTP and Redis pub-sub channels. This repository
pulls together all of the different services and allows you to set up and run
them quickly.
Installation
------------
@ -16,7 +18,7 @@ First, check out a local copy of this repository:
$ git clone git@github.com:sharelatex/sharelatex.git
$ cd sharelatex
Next install all the Node modules and ShareLaTeX services:
Next install all the node modules and ShareLaTeX services:
$ npm install
$ grunt install
@ -33,29 +35,45 @@ Dependencies
You need:
* Node.js 0.10 or greater
* Grunt command line tools (Run `npm install -g grunt-cli` to install them)
* The grunt command line tools (Run `npm install -g grunt-cli` to install them)
* A local instance of Redis and Mongodb running on their standard ports.
Config
------
ShareLaTeX should mostly run out of the box, although it uses Amazon S3 for storing binary
files like images. You will need to configure ShareLaTeX to use your own S3 access key
which can be done by editing the file at `config/settings.development.coffee`
Other repositories
------------------
ShareLaTeX consists of many separate services, each with their own Node.js process
and source code repository. These are all downloaded when you run `npm install` and
they are run when you run `grunt run`.
and source code repository. These are all downloaded and set upwhen you run
`grunt install`
The different services are:
### web-sharelatex
### [web](http://github.com/sharelatex/web-sharelatex)
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-sharelatex
### [document-updater](http://github.com/sharelatex/document-updater-sharelatex)
Process 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](http://github.com/sharelatex/clsi-sharelatex)
The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX
documents.
Contributing
------------
Please see the [CONTRIBUTING](https://github.com/sharelatex/sharelatex/blob/master/CONTRIBUTING.md) file for information on contributing to the development of ShareLaTeX.