overleaf/services/web
roo hutton d16fee1afe Merge pull request #18910 from overleaf/rh-editor-warning-over-limit
[web] Show warning modal to editors opening a project over collaborator limit

GitOrigin-RevId: d9868c021d0aaf04bffd8afbd8c1c96fbf548755
2024-06-28 08:04:53 +00:00
..
.storybook
.vscode
app [web] return file type in revertFile (#18995) 2024-06-28 08:04:45 +00:00
bin
config Merge pull request #18970 from overleaf/msm-clean-features-templates 2024-06-24 12:05:43 +00:00
cypress
data
frontend Merge pull request #18910 from overleaf/rh-editor-warning-over-limit 2024-06-28 08:04:53 +00:00
locales Merge pull request #18910 from overleaf/rh-editor-warning-over-limit 2024-06-28 08:04:53 +00:00
migrations Merge pull request #19132 from overleaf/jdt-ai-policy-migration 2024-06-26 08:04:48 +00:00
modules Merge pull request #18970 from overleaf/msm-clean-features-templates 2024-06-24 12:05:43 +00:00
public Create an organizations icon section on the new plans page 2024-06-24 12:03:42 +00:00
scripts Add waitForDb in scripts/resync_subscriptions.js (#19154) 2024-06-28 08:04:29 +00:00
test [web] return file type in revertFile (#18995) 2024-06-28 08:04:45 +00:00
transform/o-error
types Merge pull request #18861 from overleaf/rh-editor-limit-exceeded 2024-06-25 08:04:46 +00:00
webpack-plugins
.dockerignore
.eastrc
.eslintignore
.eslintrc.js Add an ESLint rule enforcing kebab-case in URL paths (#18913) 2024-06-24 12:04:26 +00:00
.gitignore
.nvmrc
.prettierignore
.prettierrc Merge pull request #3942 from overleaf/prettier-trailing-comma 2021-04-28 02:10:01 +00:00
.stylelintrc.json
app.js
babel.config.json
cloudbuild-storybook-index.html.m4
cloudbuild-storybook.yaml
cypress.config.ts
docker-compose.ci.yml
docker-compose.common.env
docker-compose.cypress.yml
docker-compose.yml
Dockerfile
Dockerfile.frontend
Dockerfile.frontend.ci
Dockerfile.frontend_ct
i18next-scanner.config.js
install_deps.sh
LICENSE
local-dev.env Merge pull request #19128 from overleaf/jdt-latex-2024-release 2024-06-27 08:04:35 +00:00
local-test.env
Makefile
Makefile.module
package.json Replace symbol palette tabs with a custom tablist (#19034) 2024-06-26 11:11:35 +00:00
README.md
tsconfig.backend.json
tsconfig.json
webpack.config.dev.js
webpack.config.js
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