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

History

Shane Kilkelly ea7d7c604e Remove token header from angular `$http`		2017-10-02 14:44:03 +01:00
..
app	Use custom header, send anonToken in payload to `joinProject`	2017-09-29 16:32:07 +01:00
config	Allow configureable brand prefix with overleaf styles	2017-08-07 17:01:59 +02:00
data
modules	update gitignore	2017-01-30 15:13:03 +00:00
public	Remove token header from angular `$http`	2017-10-02 14:44:03 +01:00
test	Working token-based access	2017-09-27 14:01:52 +01:00
.gitignore	Allow configureable brand prefix with overleaf styles	2017-08-07 17:01:59 +02:00
.npmignore
.nvmrc	Merge branch 'master' into node-6.9	2017-04-05 10:15:51 +01:00
.travis.yml
app.coffee
cleanup.js
Gruntfile.coffee	Update Project schema for overleaf imports	2017-08-21 17:49:08 +02:00
Jenkinsfile	disableConcurrentBuilds	2017-09-04 16:02:16 +01:00
npm-shrinkwrap.json	pin chai	2017-09-12 11:21:34 +01:00
package.json	pin chai	2017-09-12 11:21:34 +01:00
README.md

README.md

web-sharelatex

web-sharelatex is the front-end web service of the open-source web-based collaborative LaTeX editor, ShareLaTeX. It serves all the HTML pages, CSS and javascript to the client. web-sharelatex also contains a lot of logic around creating and editing projects, and account management.

The rest of the ShareLaTeX stack, along with information about contributing can be found in the sharelatex/sharelatex repository.

Build process

web-sharelatex uses Grunt to build its front-end related assets.

Image processing tasks are commented out in the gruntfile and the needed packages aren't presently in the project's package.json. If the images need to be processed again (minified and sprited), start by fetching the packages (npm install grunt-contrib-imagemin grunt-sprity), then decomment the tasks in Gruntfile.coffee. After this, the tasks can be called (explicitly, via grunt imagemin and grunt sprity).

Unit test status

License and Credits

This project is licensed under the AGPLv3 license

Stylesheets

ShareLaTeX is based on Bootstrap, which is licensed under the MIT license. All modifications (*.less files in public/stylesheets) are also licensed under the MIT license.

Artwork

Silk icon set 1.3

We gratefully acknowledge Mark James for releasing his Silk icon set under the Creative Commons Attribution 2.5 license. Some of these icons are used within ShareLaTeX inside the public/img/silk and public/brand/icons directories.

IconShock icons

We gratefully acknowledge IconShock for use of the icons in the public/img/iconshock directory found via findicons.com

Acceptance Tests

To run the Acceptance tests:

set allowPublicAccess to true, either in the configuration file, or by setting the environment variable SHARELATEX_ALLOW_PUBLIC_ACCESS to true
start the server (grunt)
in a separate terminal, run grunt test:acceptance