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

History

James Allen 21f88bb20e Use ide.validFileRegex, not hard coded regex		2016-09-22 14:57:59 +01:00
..
app	Don't allow files to be created with / or * characters	2016-09-21 16:31:55 +01:00
config	Set default compileTimeout to 3 minutes for onsite users	2016-09-06 11:41:21 +01:00
data
modules	ignore ldap in modules	2015-11-17 11:41:52 +00:00
public	Use ide.validFileRegex, not hard coded regex	2016-09-22 14:57:59 +01:00
test	Return type when finding element by path so that we don't need a heuristic	2016-09-19 14:35:25 +01:00
.gitignore	Add beginnings of acceptance tests	2016-03-08 15:59:04 +00:00
.npmignore
.travis.yml
app.coffee	Standardise on one Errors file	2016-03-23 15:14:49 +00:00
cleanup.js
Gruntfile.coffee	Don't watch files as grunt default	2016-09-21 10:48:23 +01:00
npm-shrinkwrap.json	Update shrinkwrap.	2016-08-10 17:46:22 +01:00
package.json	Send events to custom DB backend	2016-08-10 16:42:56 +01:00
README.md	Merge branch 'master' into sk-session-revocation	2016-07-06 13:19:15 +01:00

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