overleaf/services/web
Domagoj Kriskovic 9ce9b2c937 Add onboarding-flow in "register" and "user-registered" events (#15651)
* onboarding-flow in register event

* onboarding-flow in user-registered event

* fix typos

GitOrigin-RevId: aff8a7157062db0ec1c99499353a7c08eaa7b8b6
2023-11-13 09:03:57 +00:00
..
.github
.vscode
app Add onboarding-flow in "register" and "user-registered" events (#15651) 2023-11-13 09:03:57 +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 #15588 from overleaf/em-migrations-mongo-timeout 2023-11-07 09:05:08 +00:00
cypress Merge pull request #15629 from overleaf/ae-web-target 2023-11-07 12:35:00 +00:00
data
frontend Add timeouts to file-view-text fetch requests (#15690) 2023-11-10 09:04:27 +00:00
locales Merge pull request #14756 from overleaf/mf-group-invite-new-user-redirection 2023-11-10 09:04:23 +00:00
migrations Merge pull request #15562 from overleaf/em-drop-unused-indexes 2023-11-07 09:05:04 +00:00
modules Merge pull request #15544 from overleaf/bg-misc-use-literal-paths 2023-11-02 08:53:03 +00:00
public Merge pull request #15258 from overleaf/rd-remove-b2s 2023-10-17 08:03:22 +00:00
scripts Merge pull request #15635 from overleaf/jpa-safer-disconnect 2023-11-10 09:03:43 +00:00
test Merge pull request #15669 from overleaf/ab-fix-sso-linking-status 2023-11-10 09:04:15 +00:00
transform/o-error
types Merge pull request #14756 from overleaf/mf-group-invite-new-user-redirection 2023-11-10 09:04:23 +00:00
webpack-plugins Merge pull request #13572 from overleaf/mj-bibtex-grammar 2023-07-17 10:47:59 +00:00
.dockerignore Merge pull request #14466 from overleaf/jpa-fix-web-image 2023-08-24 08:03:49 +00:00
.eastrc
.eslintignore Merge pull request #14455 from overleaf/jpa-eslint-module-scripts 2023-08-24 08:04:04 +00:00
.eslintrc Disable transSupportBasicHtmlNodes in react-i18next config (#15430) 2023-10-31 09:04:04 +00:00
.gitignore Merge pull request #13572 from overleaf/mj-bibtex-grammar 2023-07-17 10:47:59 +00:00
.nvmrc Merge pull request #15506 from overleaf/jpa-node-18-18-2 2023-11-01 09:02:48 +00:00
.prettierignore Merge pull request #14396 from overleaf/jpa-prettier-module-scripts 2023-08-18 08:05:57 +00:00
.prettierrc
app.js Merge pull request #15241 from overleaf/em-gcp-opentelemetry 2023-10-19 08:02:52 +00:00
babel.config.json Upgrade core-js to v3.30 (#13246) 2023-07-17 10:29:03 +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 #15006 from overleaf/mj-bad-karma 2023-10-16 08:04:20 +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 #15525 from overleaf/jpa-cypress-upgrade 2023-11-01 09:03:05 +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 Merge pull request #13061 from overleaf/mj-cm6-translations 2023-05-16 08:04:11 +00:00
install_deps.sh
LICENSE
local-dev.env Merge pull request #14465 from overleaf/ab-local-dev-config-localhost-ipv4 2023-08-24 08:03:52 +00:00
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 #15632 from overleaf/jpa-prod-target 2023-11-09 09:03:16 +00:00
Makefile.module Merge pull request #14309 from overleaf/jpa-docker-compose 2023-08-15 08:03:17 +00:00
package.json Use w3c-keyname in codemirror-emacs (#15675) 2023-11-10 09:03:55 +00:00
README.md
tsconfig.json Add @ as an alias for frontend/js (#14600) 2023-09-04 08:04:22 +00:00
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 Merge pull request #15629 from overleaf/ae-web-target 2023-11-07 12:35:00 +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