Eric Mc Sween 6d931f0948 Merge pull request #13427 from overleaf/em-td-websocket-invites 3 年之前
..
.github e3f41ab373 Merge pull request #3342 from overleaf/jpa-hide-dependabot-cfg 6 年之前
.vscode c6f9da69da Merge pull request #10995 from overleaf/lg-update-tpds-dropbox-only 3 年之前
app 6d931f0948 Merge pull request #13427 from overleaf/em-td-websocket-invites 3 年之前
bin 3988f815af Merge pull request #13182 from overleaf/jpa-disable-sentry-upload 3 年之前
config 7e6613a1a0 Merge pull request #13327 from overleaf/msm-web-track-changes-cleanup 3 年之前
cypress e0d327a3e8 Skip/improve flaky pdf tests (#13150) 3 年之前
data d706109823 Merge pull request #5615 from overleaf/revert-5611-revert-4746-ae-project-history 5 年之前
frontend 5e1700b97a Merge pull request #13383 from overleaf/jk-fix-error-handling-password-reset-form 3 年之前
locales 2e77d4ab65 Teardown onboarding video tour test (#13351) 3 年之前
migrations 234eb31ffb Merge pull request #13082 from overleaf/msm-migration-check-history 3 年之前
modules 7e6613a1a0 Merge pull request #13327 from overleaf/msm-web-track-changes-cleanup 3 年之前
public 8c549aa0fa Implement new welcome page UI with split test (#11677) 3 年之前
scripts 7e6613a1a0 Merge pull request #13327 from overleaf/msm-web-track-changes-cleanup 3 年之前
test 6d931f0948 Merge pull request #13427 from overleaf/em-td-websocket-invites 3 年之前
transform 1be43911b4 Merge pull request #3942 from overleaf/prettier-trailing-comma 5 年之前
types 27c2d1c16e [web] Personal Access Token Settings UI (#13040) 3 年之前
webpack-plugins 7f37ba737c Move source editor out of module (#12457) 3 年之前
.eastrc 11ce07ec50 Merge pull request #1999 from overleaf/spd-migrations 7 年之前
.eslintignore 7f37ba737c Move source editor out of module (#12457) 3 年之前
.eslintrc 510e686b7b Upgrade ESLint plugins (#13153) 3 年之前
.gitignore 7e6613a1a0 Merge pull request #13327 from overleaf/msm-web-track-changes-cleanup 3 年之前
.nvmrc cb8992e912 Merge pull request #12709 from overleaf/bg-rollback-additional-services 3 年之前
.prettierignore 7f37ba737c Move source editor out of module (#12457) 3 年之前
.prettierrc 1be43911b4 Merge pull request #3942 from overleaf/prettier-trailing-comma 5 年之前
Dockerfile cb8992e912 Merge pull request #12709 from overleaf/bg-rollback-additional-services 3 年之前
Dockerfile.frontend cb8992e912 Merge pull request #12709 from overleaf/bg-rollback-additional-services 3 年之前
Dockerfile.frontend.ci 2421593d85 run unit and acceptance tests in parallel (#1545) 7 年之前
Dockerfile.frontend_ct 53324b0cd2 Add Cypress React component testing (#6974) 4 年之前
LICENSE f0f29e2f17 Merge pull request #2976 from overleaf/jpa-import-671 6 年之前
Makefile 11716cbd05 Merge pull request #13020 from overleaf/mj-cypress-test-edit-separately 3 年之前
Makefile.module 46fb6f7c83 Merge pull request #12814 from overleaf/jpa-modules-rs-init 3 年之前
README.md c41c14c697 Remove deprecated grunt code (#9506) 4 年之前
app.js adfe7abaaf Merge pull request #13255 from overleaf/em-socket-leak-detection 3 年之前
babel.config.json 4b968017a0 Upgrade core-js to v3.30 (#13246) 3 年之前
cypress.config.ts 11716cbd05 Merge pull request #13020 from overleaf/mj-cypress-test-edit-separately 3 年之前
docker-compose.ci.yml 6c29e0a36e Merge pull request #13251 from overleaf/msm-update-mongo-5 3 年之前
docker-compose.common.env cb8992e912 Merge pull request #12709 from overleaf/bg-rollback-additional-services 3 年之前
docker-compose.cypress.yml 6926c4bd84 Upgrade Cypress to 12.12.0 (#13152) 3 年之前
docker-compose.yml 6c29e0a36e Merge pull request #13251 from overleaf/msm-update-mongo-5 3 年之前
i18next-scanner.config.js 5fd4504f51 Merge pull request #13061 from overleaf/mj-cm6-translations 3 年之前
install_deps.sh f3f0be5c56 Merge pull request #6211 from overleaf/em-code-sharing 4 年之前
karma.conf.js 1be43911b4 Merge pull request #3942 from overleaf/prettier-trailing-comma 5 年之前
local-dev.env 4df1641355 Merge pull request #13075 from overleaf/em-mongo-localhost-connection 3 年之前
local-test.env 6f4975b721 Merge pull request #9750 from overleaf/ho-redis-volatile 4 年之前
nodemon.json ae0c347f27 Merge pull request #6542 from overleaf/jpa-em-code-sharing-workspaces 4 年之前
package.json de17f883f7 Merge pull request #13222 from overleaf/ae-less-cleanup 3 年之前
tsconfig.json 5382178309 Merge pull request #13223 from overleaf/ae-typescript-upgrade 3 年之前
webpack.config.dev.js 9a5a3d4372 Merge pull request #9830 from overleaf/ae-exclude-hot-source-editor 4 年之前
webpack.config.js 1f7d317db9 Upgrade pdf.js to 3.6.172 (#13112) 3 年之前
webpack.config.prod.js 81816cfa2c Merge pull request #8028 from overleaf/ae-css-minimizer 4 年之前
webpack.config.test.js 69a2283984 Upgrade to webpack v5 (#7249) 4 年之前

README.md

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