overleaf/services/web
Jakob Ackermann 926d8911e1 Merge pull request #14913 from overleaf/jpa-no-cache-for-anon
[web] purge split test cache for anonymous users

GitOrigin-RevId: e268b30ac03d4cab0f7976657089c58bc3c84210
2023-09-25 08:04:30 +00:00
..
.github
.vscode Merge pull request #10995 from overleaf/lg-update-tpds-dropbox-only 2023-01-09 09:04:02 +00:00
app Merge pull request #14913 from overleaf/jpa-no-cache-for-anon 2023-09-25 08:04:30 +00:00
bin Revert "[web] temporarily disable upload of source maps to sentry" (#14386) 2023-08-18 12:11:41 +00:00
config Merge pull request #14861 from overleaf/jpa-web-restrict-new-subscription 2023-09-21 08:03:56 +00:00
cypress Merge pull request #14499 from overleaf/mj-table-gen-tests 2023-08-30 08:04:40 +00:00
data
frontend Revert "allow underscore in hyperref labels" (#14926) 2023-09-22 08:03:48 +00:00
locales Merge pull request #14874 from overleaf/tm-compile-timeout-20s-plans-pages 2023-09-19 08:04:01 +00:00
migrations Merge pull request #14383 from overleaf/jpa-server-pro-feature-refresh-migration 2023-08-18 08:05:53 +00:00
modules Merge pull request #14696 from overleaf/jpa-lean-mongo-queries 2023-09-08 08:04:08 +00:00
public Implement Back to School 2023 banners and modal (#14363) 2023-08-24 08:04:09 +00:00
scripts Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
test Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
transform/o-error
types Implement test to reduce compile timeout to 20 seconds (#14705) 2023-09-19 08:03:52 +00:00
webpack-plugins Merge pull request #13572 from overleaf/mj-bibtex-grammar 2023-07-17 10:47:59 +00:00
.dockerignore Merge pull request #14466 from overleaf/jpa-fix-web-image 2023-08-24 08:03:49 +00:00
.eastrc
.eslintignore Merge pull request #14455 from overleaf/jpa-eslint-module-scripts 2023-08-24 08:04:04 +00:00
.eslintrc Merge pull request #14727 from overleaf/bg-eslint-rule-for-node-fetch 2023-09-11 08:05:10 +00:00
.gitignore Merge pull request #13572 from overleaf/mj-bibtex-grammar 2023-07-17 10:47:59 +00:00
.nvmrc Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
.prettierignore Merge pull request #14396 from overleaf/jpa-prettier-module-scripts 2023-08-18 08:05:57 +00:00
.prettierrc
app.js Merge pull request #14103 from overleaf/jpa-web-create-dump-once 2023-08-03 08:03:37 +00:00
babel.config.json Upgrade core-js to v3.30 (#13246) 2023-07-17 10:29:03 +00:00
cypress.config.ts Merge pull request #13020 from overleaf/mj-cypress-test-edit-separately 2023-05-11 08:04:39 +00:00
docker-compose.ci.yml Merge pull request #14843 from overleaf/jpa-no-restart 2023-09-18 08:03:54 +00:00
docker-compose.common.env Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
docker-compose.cypress.yml Upgrade Cypress to 12.17.1 (#13827) 2023-07-20 08:04:42 +00:00
docker-compose.yml Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
Dockerfile Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
Dockerfile.frontend Merge pull request #14902 from overleaf/jpa-node-18-18-0 2023-09-25 08:04:25 +00:00
Dockerfile.frontend.ci
Dockerfile.frontend_ct
i18next-scanner.config.js Merge pull request #13061 from overleaf/mj-cm6-translations 2023-05-16 08:04:11 +00:00
install_deps.sh
karma.conf.js
LICENSE
local-dev.env Merge pull request #14465 from overleaf/ab-local-dev-config-localhost-ipv4 2023-08-24 08:03:52 +00:00
local-test.env Merge pull request #14465 from overleaf/ab-local-dev-config-localhost-ipv4 2023-08-24 08:03:52 +00:00
Makefile Merge pull request #14308 from overleaf/jpa-reduce-ci-concurrency 2023-08-15 08:03:20 +00:00
Makefile.module Merge pull request #14309 from overleaf/jpa-docker-compose 2023-08-15 08:03:17 +00:00
nodemon.json
package.json Merge pull request #14903 from overleaf/revert-14869-revert-14603-td-upgrade-semver 2023-09-21 08:03:43 +00:00
README.md
tsconfig.json Add @ as an alias for frontend/js (#14600) 2023-09-04 08:04:22 +00:00
webpack.config.dev.js Add webpack optimization.runtimeChunk as a configurable setting (#13818) 2023-07-17 11:05:09 +00:00
webpack.config.js Allow non-async chunks to be analysed for shared modules (#14671) 2023-09-15 08:04:58 +00:00
webpack.config.prod.js
webpack.config.test.js

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.

Running the app

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

$ npm install
$ npm run start

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