overleaf/services/web
Jessica Lawshe b8ccb01f88 Merge pull request #17163 from overleaf/jel-dev-env-tests-mongo
[web] Use mongosh for tests in individual modules

GitOrigin-RevId: e2ca316434b39c348efcb0a289652931a6ce95e6
2024-02-19 09:04:32 +00:00
..
.storybook Merge pull request #16971 from overleaf/td-bootstrap-5-base 2024-02-15 09:04:05 +00:00
.vscode
app Merge pull request #17091 from overleaf/jel-promisify-password-reset 2024-02-19 09:04:29 +00:00
bin Merge pull request #15700 from overleaf/gs-verify-cdn-upload 2023-11-10 09:03:51 +00:00
config [web] Rebrand public access environment variables (#17013) 2024-02-14 09:04:25 +00:00
cypress Preserve folder structure when uploading folders (#16502) 2024-02-16 09:05:07 +00:00
data
frontend Merge pull request #17128 from overleaf/em-filter-out-comments 2024-02-19 09:04:00 +00:00
locales Merge pull request #17008 from overleaf/jpa-jdt-wf-consent-init 2024-02-19 09:03:38 +00:00
migrations Merge pull request #15748 from overleaf/em-drop-docops-collection 2024-02-01 09:03:46 +00:00
modules Merge pull request #16854 from overleaf/jpa-overleaf-integration-core-tests 2024-02-05 09:04:05 +00:00
public Merge pull request #16891 from overleaf/ds-filling-customer-stories-content 2024-02-13 09:03:28 +00:00
scripts Merge pull request #16948 from overleaf/jpa-rails-sharelatex-rebranding-step-2 2024-02-13 09:03:35 +00:00
test Merge pull request #17091 from overleaf/jel-promisify-password-reset 2024-02-19 09:04:29 +00:00
transform/o-error
types Preserve folder structure when uploading folders (#16502) 2024-02-16 09:05:07 +00:00
webpack-plugins
.dockerignore
.eastrc
.eslintignore
.eslintrc Merge pull request #15710 from overleaf/tm-no-constant-binary-expressions 2024-01-16 09:04:09 +00:00
.gitignore
.nvmrc Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
.prettierignore
.prettierrc
app.js Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
babel.config.json Use more native code instead of Babel polyfills, for performance (#16966) 2024-02-12 09:03:13 +00:00
cloudbuild-storybook-index.html.m4 Move Storybook back into web (#13219) 2023-12-15 09:03:15 +00:00
cloudbuild-storybook.yaml Restore npm ci step for storybook build (#16247) 2023-12-15 09:03:19 +00:00
cypress.config.ts Upgrade Cypress to 13.3.0 (#15162) 2023-10-10 07:57:39 +00:00
docker-compose.ci.yml Merge pull request #16849 from overleaf/hb-issue-16799-mongdodb-v5-to-v6 2024-02-14 09:04:38 +00:00
docker-compose.common.env [web] Rebrand public access environment variables (#17013) 2024-02-14 09:04:25 +00:00
docker-compose.cypress.yml Merge pull request #15525 from overleaf/jpa-cypress-upgrade 2023-11-01 09:03:05 +00:00
docker-compose.yml Merge pull request #16849 from overleaf/hb-issue-16799-mongdodb-v5-to-v6 2024-02-14 09:04:38 +00:00
Dockerfile Merge pull request #16524 from overleaf/em-fix-typescript-backend 2024-01-17 09:03:42 +00:00
Dockerfile.frontend Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
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 #16849 from overleaf/hb-issue-16799-mongdodb-v5-to-v6 2024-02-14 09:04:38 +00:00
Makefile.module Merge pull request #17163 from overleaf/jel-dev-env-tests-mongo 2024-02-19 09:04:32 +00:00
package.json Merge pull request #16971 from overleaf/td-bootstrap-5-base 2024-02-15 09:04:05 +00:00
README.md
tsconfig.backend.json Merge pull request #16385 from overleaf/em-typescript-other-services 2024-01-12 09:03:22 +00:00
tsconfig.json Move Storybook back into web (#13219) 2023-12-15 09:03:15 +00:00
webpack.config.dev.js Disable webpack error overlay(s) (#16906) 2024-02-06 09:03:37 +00:00
webpack.config.js Merge pull request #16971 from overleaf/td-bootstrap-5-base 2024-02-15 09:04:05 +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