overleaf/services/web
Jimmy Domagala-Tang 27fb9aadf3 Merge pull request #20937 from overleaf/jdt-ai-addon-grants-feat
Grant feature access to users purchasing the ai add-on

GitOrigin-RevId: a4183beab957e4d0c362c8f0978be395b86ce398
2024-10-14 11:09:09 +00:00
..
.storybook [storybook] Update Storybook and add a control for BS3/BS5 (#20948) 2024-10-14 11:07:40 +00:00
.vscode
app Merge pull request #20937 from overleaf/jdt-ai-addon-grants-feat 2024-10-14 11:09:09 +00:00
bin Only use sentry-cli sourcemaps upload (#20852) 2024-10-14 11:06:41 +00:00
config Merge pull request #20987 from overleaf/mj-write-and-cite-settings-icons 2024-10-14 11:08:09 +00:00
cypress Set workerPublicPath in webpack config (#20629) 2024-10-14 11:06:45 +00:00
data
frontend Merge pull request #20571 from overleaf/jdt-ai-addon-personal-upgrade 2024-10-14 11:09:04 +00:00
locales Fix accept changes request for new review panel (#20956) 2024-10-14 11:08:44 +00:00
migrations Merge pull request #20770 from overleaf/ls-drop-unused-collections 2024-10-14 11:03:59 +00:00
modules Convert app.js to ES modules 2024-10-14 11:04:23 +00:00
public Merge pull request #20797 from overleaf/jel-checkmark-green 2024-10-14 11:05:57 +00:00
scripts Merge pull request #20980 from overleaf/jpa-extend-create-project 2024-10-14 11:08:04 +00:00
test Merge pull request #20561 from overleaf/rh-duplicate-invite 2024-10-14 11:08:00 +00:00
transform/o-error
types Merge pull request #20571 from overleaf/jdt-ai-addon-personal-upgrade 2024-10-14 11:09:04 +00:00
webpack-plugins
.dockerignore
.eastrc Merge pull request #20732 from overleaf/revert-20731-revert-20480-ls-convert-migration-scripts-to-esm 2024-10-14 10:58:50 +00:00
.eslintignore Use Hunspell for client-side spellchecking (#20286) 2024-10-14 10:58:36 +00:00
.eslintrc.js Add mjs support to eslint 2024-10-14 10:59:51 +00:00
.gitignore Merge pull request #19220 from overleaf/jpa-precompile-pug 2024-07-04 08:04:51 +00:00
.nvmrc
.prettierignore Use Hunspell for client-side spellchecking (#20286) 2024-10-14 10:58:36 +00:00
.prettierrc
.stylelintrc.json Merge pull request #19472 from overleaf/rd-stylelint-ci 2024-07-23 08:04:09 +00:00
app.mjs Convert server and router files to ES modules 2024-10-14 11:04:28 +00:00
babel.config.json Update core-js 2024-10-14 11:00:55 +00:00
cloudbuild-storybook-index.html.m4
cloudbuild-storybook.yaml
cypress.config.ts
docker-compose.ci.yml
docker-compose.common.env Merge pull request #19901 from overleaf/ac-confirm-institution-domain-queue-in-institution-module 2024-08-14 08:05:39 +00:00
docker-compose.cypress.yml Upgrade Babel, Webpack and Cypress dependencies (#19729) 2024-08-02 08:05:57 +00:00
docker-compose.yml Upgrade Babel, Webpack and Cypress dependencies (#19729) 2024-08-02 08:05:57 +00:00
Dockerfile Convert app.js to ES modules 2024-10-14 11:04:23 +00:00
Dockerfile.frontend
Dockerfile.frontend.ci
Dockerfile.frontend_ct Fix Dockerfile FromAsCasing warnings (#20388) 2024-09-23 08:04:52 +00:00
i18next-scanner.config.js
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 Merge pull request #19816 from overleaf/jpa-type-tweaks 2024-08-07 08:05:08 +00:00
Makefile.module
package.json [storybook] Update Storybook and add a control for BS3/BS5 (#20948) 2024-10-14 11:07:40 +00:00
README.md Merge pull request #20062 from overleaf/ab-saas-authentication-module-renaming 2024-08-23 08:04:43 +00:00
tsconfig.backend.json
tsconfig.json
webpack.config.dev.js Move runtimeChunk optimisation to production webpack config (#18982) 2024-08-02 08:04:43 +00:00
webpack.config.js Set workerPublicPath in webpack config (#20629) 2024-10-14 11:06:45 +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=saas-authentication

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=saas-authentication

Module tests can also use a MOCHA_GREP argument:

make test_unit_module MODULE=saas-authentication 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=saas-authentication

Module tests can also use a MOCHA_GREP argument:

make test_acceptance_module MODULE=saas-authentication 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