overleaf/services/web
M Fahru ef0e1cff8d Add comment to explain the usage of font-feature-settings: "ss05" rule on the DM Mono font
GitOrigin-RevId: f9ec7868a425136a9f4b2b8e8546747dcbf434e3
2024-02-09 09:07:39 +00:00
..
.storybook Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
.vscode
app Merge pull request #16657 from overleaf/dp-mongoose-callback-project-update-handler 2024-02-09 09:07:27 +00:00
bin
config Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
cypress Remove MathJax v2 (#16961) 2024-02-09 09:06:42 +00:00
data
frontend Add comment to explain the usage of font-feature-settings: "ss05" rule on the DM Mono font 2024-02-09 09:07:39 +00:00
locales Merge pull request #16900 from overleaf/jel-delete-sso-config 2024-02-09 09:06:16 +00:00
migrations
modules Merge pull request #16854 from overleaf/jpa-overleaf-integration-core-tests 2024-02-05 09:04:05 +00:00
public
scripts
test Merge pull request #16657 from overleaf/dp-mongoose-callback-project-update-handler 2024-02-09 09:07:27 +00:00
transform/o-error
types Standardise types for ranges (#16927) 2024-02-09 09:06:51 +00:00
webpack-plugins
.dockerignore
.eastrc
.eslintignore
.eslintrc
.gitignore
.nvmrc
.prettierignore
.prettierrc
app.js
babel.config.json
cloudbuild-storybook-index.html.m4 Move Storybook back into web (#13219) 2023-12-15 09:03:15 +00:00
cloudbuild-storybook.yaml
cypress.config.ts
docker-compose.ci.yml Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
docker-compose.common.env Rebrand SAML env variables to Overleaf 2024-02-09 09:05:46 +00:00
docker-compose.cypress.yml
docker-compose.yml Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
Dockerfile
Dockerfile.frontend
Dockerfile.frontend.ci
Dockerfile.frontend_ct
i18next-scanner.config.js
install_deps.sh Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
LICENSE
local-dev.env Rebrand SAML env variables to Overleaf 2024-02-09 09:05:46 +00:00
local-test.env Rebrand SAML env variables to Overleaf 2024-02-09 09:05:46 +00:00
Makefile Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
Makefile.module Merge pull request #16859 from overleaf/jpa-sharelatex-cleanup 2024-02-09 09:04:11 +00:00
package.json Remove MathJax v2 (#16961) 2024-02-09 09:06:42 +00:00
README.md
tsconfig.backend.json
tsconfig.json
webpack.config.dev.js Disable webpack error overlay(s) (#16906) 2024-02-06 09:03:37 +00:00
webpack.config.js Remove MathJax v2 (#16961) 2024-02-09 09:06:42 +00:00
webpack.config.prod.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