overleaf/services/web
Rebeka Dekany d56f7f7442 Merge pull request #16122 from overleaf/odc-cookie-banner
[web] The cookie banner should not overlap the buttons of the onboarding data form on mobile view

GitOrigin-RevId: e7a20886f5608a6bf2c46d101c6e924261ec05d0
2023-12-07 09:04:05 +00:00
..
.github
.vscode
app Merge pull request #16035 from overleaf/bg-group-sso-login-errors 2023-12-06 09:05:16 +00:00
bin Merge pull request #15700 from overleaf/gs-verify-cdn-upload 2023-11-10 09:03:51 +00:00
config Merge pull request #15906 from overleaf/jdt-disable-staging-captchas-if-trusted 2023-11-29 09:04:39 +00:00
cypress Merge pull request #15901 from overleaf/tm-design-system-updates-teardown 2023-11-28 09:04:06 +00:00
data
frontend Merge pull request #16122 from overleaf/odc-cookie-banner 2023-12-07 09:04:05 +00:00
locales Merge pull request #16035 from overleaf/bg-group-sso-login-errors 2023-12-06 09:05:16 +00:00
migrations Merge pull request #15930 from overleaf/jpa-fix-east-hang 2023-11-27 09:04:05 +00:00
modules Merge pull request #16001 from overleaf/jpa-web-real-time-auto-join-only 2023-11-30 09:03:49 +00:00
public [web] Implement homepage redesign (#15905) 2023-12-05 09:04:40 +00:00
scripts Merge pull request #16045 from overleaf/revert-16012-jpa-purge-legacy-pw 2023-11-30 09:04:04 +00:00
test Merge pull request #16073 from overleaf/em-postpone-tutorials 2023-12-06 09:04:58 +00:00
transform/o-error
types Merge pull request #16066 from overleaf/jdt-revert-ieee-fix 2023-12-01 09:03:21 +00:00
webpack-plugins
.dockerignore
.eastrc
.eslintignore
.eslintrc Remove Ace (#14299) 2023-11-29 09:04:08 +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
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 #15993 from overleaf/csh-issue-15655-migrate-remaining-apps 2023-11-29 09:05:01 +00:00
docker-compose.common.env Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +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 #15993 from overleaf/csh-issue-15655-migrate-remaining-apps 2023-11-29 09:05:01 +00:00
Dockerfile Merge pull request #15629 from overleaf/ae-web-target 2023-11-07 12:35:00 +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
LICENSE
local-dev.env
local-test.env Merge pull request #15141 from overleaf/ab-fix-local-acceptance-testing 2023-10-12 08:03:26 +00:00
Makefile Merge pull request #15993 from overleaf/csh-issue-15655-migrate-remaining-apps 2023-11-29 09:05:01 +00:00
Makefile.module
package.json Upgrade react-resizable-panels (#15998) 2023-12-06 09:04:40 +00:00
README.md
tsconfig.json
webpack.config.dev.js Merge pull request #15514 from overleaf/jpa-single-webpack-runtime 2023-11-01 09:03:16 +00:00
webpack.config.js Remove Ace (#14299) 2023-11-29 09:04:08 +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