overleaf/services/web
Alf Eaton 6b14996843 Merge pull request #9968 from overleaf/td-add-cm6-delete-metrics
Add delete events to the CM6 performance metrics

GitOrigin-RevId: 1adc65abda960037d40a7a7442d11a0980f6cd3a
2022-10-19 08:04:23 +00:00
..
.github
.vscode
app Merge pull request #10005 from overleaf/em-revert-get-best-subscription 2022-10-18 08:03:49 +00:00
bin
config Remove deprecated grunt code (#9506) 2022-09-16 08:05:37 +00:00
cypress Upgrade Cypress to 10.2.0 (#8545) 2022-06-24 08:04:09 +00:00
data
frontend Merge pull request #9968 from overleaf/td-add-cm6-delete-metrics 2022-10-19 08:04:23 +00:00
locales Merge pull request #9866 from overleaf/ta-pdf-detach-safari-no-warnings 2022-10-18 08:03:20 +00:00
migrations [web/scripts] Process users' projects with promiseMapWithLimit() (#9807) 2022-10-05 08:04:02 +00:00
modules Merge pull request #9956 from overleaf/em-node-fetch-web 2022-10-18 08:03:25 +00:00
public Merge pull request #9466 from overleaf/jk-add-labs-program-for-galileo 2022-09-22 08:03:59 +00:00
scripts Merge pull request #9967 from overleaf/jpa-web-scripts-increase-timeouts 2022-10-18 08:03:06 +00:00
test Merge pull request #9981 from overleaf/ae-cypress-tweaks 2022-10-19 08:03:52 +00:00
transform/o-error
types Merge pull request #9882 from overleaf/ii-dashboard-system-message-migration 2022-10-13 08:05:38 +00:00
webpack-plugins Merge pull request #8584 from overleaf/jk-fix-ce-build 2022-07-04 08:03:12 +00:00
.eastrc
.eslintignore Merge pull request #7880 from overleaf/jk-cm6-parser-migrate-to-web 2022-06-24 08:03:44 +00:00
.eslintrc Add types (#8154) 2022-05-30 08:03:45 +00:00
.gitignore Merge pull request #9054 from overleaf/ii-gitignore-cypress-screenshots 2022-08-01 08:03:25 +00:00
.nvmrc Merge pull request #9819 from overleaf/bg-node-upgrade 2022-10-04 08:02:41 +00:00
.prettierignore Merge pull request #7880 from overleaf/jk-cm6-parser-migrate-to-web 2022-06-24 08:03:44 +00:00
.prettierrc
app.js Merge pull request #9099 from overleaf/jpa-web-graceful-shutdown 2022-08-05 08:03:27 +00:00
babel.config.json Merge pull request #8014 from overleaf/ae-babel-test-env 2022-05-20 08:04:03 +00:00
cypress.config.ts Merge pull request #9050 from overleaf/ii-cypress-artifacts 2022-08-01 08:03:19 +00:00
docker-compose.ci.yml Merge pull request #9455 from overleaf/em-recreate-dropbox-entities 2022-09-02 08:05:09 +00:00
docker-compose.common.env Merge pull request #6661 from overleaf/spd-local-tests 2022-08-10 08:03:45 +00:00
docker-compose.yml Merge pull request #9893 from overleaf/ae-upgrade-cypress-2 2022-10-11 08:03:31 +00:00
Dockerfile Merge pull request #9819 from overleaf/bg-node-upgrade 2022-10-04 08:02:41 +00:00
Dockerfile.frontend Merge pull request #9819 from overleaf/bg-node-upgrade 2022-10-04 08:02:41 +00:00
Dockerfile.frontend.ci
Dockerfile.frontend_ct
i18next-scanner.config.js
install_deps.sh
karma.conf.js
LICENSE
local-dev.env Merge pull request #9750 from overleaf/ho-redis-volatile 2022-09-30 08:04:30 +00:00
local-test.env Merge pull request #9750 from overleaf/ho-redis-volatile 2022-09-30 08:04:30 +00:00
Makefile Re-enable type checking in CI (#8114) 2022-05-27 08:03:20 +00:00
Makefile.module
nodemon.json
package.json Merge pull request #9956 from overleaf/em-node-fetch-web 2022-10-18 08:03:25 +00:00
README.md Remove deprecated grunt code (#9506) 2022-09-16 08:05:37 +00:00
tsconfig.json Merge pull request #8139 from overleaf/ii-typescript-enable-strict-mode 2022-06-01 08:03:35 +00:00
webpack.config.dev.js Merge pull request #9830 from overleaf/ae-exclude-hot-source-editor 2022-10-07 08:04:05 +00:00
webpack.config.js Merge pull request #9823 from overleaf/em-webpack-shared-libs 2022-10-05 13:25:47 +00:00
webpack.config.prod.js Merge pull request #8028 from overleaf/ae-css-minimizer 2022-05-20 08:04:14 +00:00
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