overleaf/services/web
CloudBuild 7cb90882b6 auto update translation
GitOrigin-RevId: dc4081d861bb0d3ee12e5ce731440faa32bcfa98
2020-09-17 02:04:57 +00:00
..
.github Merge pull request #3161 from overleaf/jpa-dependabot-config 2020-09-05 02:05:27 +00:00
.vscode Merge pull request #1440 from overleaf/as-amd-webpack 2019-10-16 10:36:21 +00:00
app Merge pull request #3178 from overleaf/cmg-ace-upgrade-1.4.12 2020-09-17 02:04:49 +00:00
bin Merge pull request #3113 from overleaf/jpa-translations-mono-repo 2020-08-19 02:06:08 +00:00
config [misc] optionally skip adding the routes of the launchpad module (#3194) 2020-09-16 02:05:08 +00:00
data
frontend Merge pull request #3178 from overleaf/cmg-ace-upgrade-1.4.12 2020-09-17 02:04:49 +00:00
locales auto update translation 2020-09-17 02:04:57 +00:00
modules [misc] optionally skip adding the routes of the launchpad module (#3194) 2020-09-16 02:05:08 +00:00
public Merge pull request #2523 from overleaf/revert-2520-revert-2488-as-import-pr-708 2020-01-29 12:07:22 +00:00
scripts Merge pull request #3158 from overleaf/as-fix-react-replacement-tag-sanitisation 2020-09-05 02:05:17 +00:00
test Merge pull request #3190 from overleaf/jel-new-cta-email-body 2020-09-17 02:04:38 +00:00
transform/o-error Merge pull request #3114 from overleaf/msm-remove-logger-warn-controllers 2020-08-20 02:06:25 +00:00
.babelrc Merge pull request #3157 from overleaf/ta-outline-item-tests 2020-09-16 02:04:31 +00:00
.dockerignore Merge pull request #3068 from overleaf/jpa-block-npm-i-outside-docker 2020-08-10 15:55:16 +00:00
.eastrc Merge pull request #1999 from overleaf/spd-migrations 2019-10-01 12:09:58 +00:00
.eslintignore Merge pull request #3109 from overleaf/ta-metrics-tooltips 2020-08-19 02:06:25 +00:00
.eslintrc Merge pull request #3022 from overleaf/as-react-linting 2020-07-21 02:06:23 +00:00
.gitignore Merge pull request #3081 from overleaf/jpa-npmc-via-dev-env 2020-08-10 15:56:04 +00:00
.prettierignore Merge pull request #3109 from overleaf/ta-metrics-tooltips 2020-08-19 02:06:25 +00:00
.prettierrc Merge pull request #1037 from sharelatex/as-decaffeinate 2018-11-05 10:19:25 +00:00
app.js Merge pull request #2507 from overleaf/bg-graceful-shutdown 2020-01-14 04:14:44 +00:00
docker-compose.ci.yml Merge pull request #3071 from overleaf/spd-unhandled-promises-in-tests 2020-08-12 02:07:09 +00:00
docker-compose.yml Merge pull request #3071 from overleaf/spd-unhandled-promises-in-tests 2020-08-12 02:07:09 +00:00
Dockerfile Merge pull request #2929 from overleaf/jpa-ci-3m30s-with-custom-cloudbuild 2020-07-03 02:04:13 +00:00
Dockerfile.frontend Merge pull request #2882 from overleaf/bg-update-node-10.21.0 2020-06-03 10:31:21 +00:00
Dockerfile.frontend.ci run unit and acceptance tests in parallel (#1545) 2019-03-11 11:00:58 +00:00
install_deps.sh Merge pull request #3113 from overleaf/jpa-translations-mono-repo 2020-08-19 02:06:08 +00:00
karma.conf.js Merge pull request #2950 from overleaf/as-jsdom-tests 2020-07-11 02:04:35 +00:00
LICENSE Merge pull request #2976 from overleaf/jpa-import-671 2020-07-08 02:04:19 +00:00
Makefile Merge pull request #3052 from overleaf/ta-lint-no-q 2020-08-10 15:55:09 +00:00
Makefile.module Merge pull request #2845 from overleaf/jpa-faster-web-ci 2020-05-23 03:18:08 +00:00
nodemon.json Merge pull request #1717 from overleaf/as-decaffeinate-backend 2019-05-29 09:32:21 +00:00
package-lock.json Merge pull request #3137 from overleaf/msm-react-error-boundary 2020-09-17 02:04:33 +00:00
package.json Merge pull request #3137 from overleaf/msm-react-error-boundary 2020-09-17 02:04:33 +00:00
README.md Merge pull request #2342 from overleaf/fix-readme-typo 2019-11-12 09:15:09 +00:00
webpack.config.dev.js Merge pull request #2349 from overleaf/as-webpack-css 2019-11-28 10:39:09 +00:00
webpack.config.js Merge pull request #3134 from overleaf/as-react-i18n 2020-09-05 02:05:04 +00:00
webpack.config.prod.js Merge pull request #2929 from overleaf/jpa-ci-3m30s-with-custom-cloudbuild 2020-07-03 02:04:13 +00:00
webpack.config.test.js Merge pull request #1440 from overleaf/as-amd-webpack 2019-10-16 10:36:21 +00:00

overleaf/web

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

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

Build process

overleaf/web 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).

New Docker-based build process

Note that the Grunt workflow from above should still work, but we are transitioning to a Docker based testing workflow, which is documented below:

Running the app

The app runs natively using npm and Node on the local system:

$ npm install
$ npm run start

Ideally the app would run in Docker like the tests below, but with host networking not supported in OS X, we need to run it natively until all services are Dockerised.

Running Tests

To run all tests run:

make test

To run both unit and acceptance tests for a module run:

make test_module MODULE=overleaf-integration

Unit Tests

The test suites run in Docker.

Unit tests can be run in the test_unit container defined in docker-compose.tests.yml.

The makefile contains a short cut to run these:

make test_unit

During development it is often useful to only run a subset of tests, which can be configured with arguments to the mocha CLI:

make test_unit MOCHA_GREP='AuthorizationManager'

To run only the unit tests for a single module do:

make test_unit_module MODULE=overleaf-integration

Module tests can also use a MOCHA_GREP argument:

make test_unit_module MODULE=overleaf-integration MOCHA_GREP=SSO

Acceptance Tests

Acceptance tests are run against a live service, which runs in the acceptance_test container defined in docker-compose.tests.yml.

To run the tests out-of-the-box, the makefile defines:

make test_acceptance

However, during development it is often useful to leave the service running for rapid iteration on the acceptance tests. This can be done with:

make test_acceptance_app_start_service
make test_acceptance_app_run # Run as many times as needed during development
make test_acceptance_app_stop_service

make test_acceptance just runs these three commands in sequence and then runs make test_acceptance_modules which performs the tests for each module in the modules directory. (Note that there is not currently an equivalent to the -start / -run x n / -stop series for modules.)

During development it is often useful to only run a subset of tests, which can be configured with arguments to the mocha CLI:

make test_acceptance_run MOCHA_GREP='AuthorizationManager'

To run only the acceptance tests for a single module do:

make test_acceptance_module MODULE=overleaf-integration

Module tests can also use a MOCHA_GREP argument:

make test_acceptance_module MODULE=overleaf-integration MOCHA_GREP=SSO

Routes

Run bin/routes to print out all routes in the project.

License and Credits

This project is licensed under the AGPLv3 license

Stylesheets

Overleaf 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 Overleaf 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