Domagoj Kriskovic 39bd64b0a4 [cm6] fix toolbar overflow button calculation (#13669) преди 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 afbd143f0f Remove unused code and translation locales from old subscription pages (#13646) преди 3 години
bin 3988f815af Merge pull request #13182 from overleaf/jpa-disable-sentry-upload преди 3 години
config a14e2aecfb Merge pull request #13483 from overleaf/jk-managed-users-group-management-ui преди 3 години
cypress 283c1d7282 Merge pull request #13605 from overleaf/ae-meta-tests преди 3 години
data d706109823 Merge pull request #5615 from overleaf/revert-5611-revert-4746-ae-project-history преди 5 години
frontend 39bd64b0a4 [cm6] fix toolbar overflow button calculation (#13669) преди 3 години
locales afbd143f0f Remove unused code and translation locales from old subscription pages (#13646) преди 3 години
migrations 6ee5f6a0a0 Merge pull request #13497 from overleaf/jdt-extract-user-feature-set преди 3 години
modules 8cdfffa6f9 Merge pull request #13526 from overleaf/ds-layout-change преди 3 години
public 8cd9b4051c add split test variant for the registration and login page преди 3 години
scripts 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 3 години
test 7202d7413e [rich text] Cover the whole command when selecting end-to-end (#11683) преди 3 години
transform 1be43911b4 Merge pull request #3942 from overleaf/prettier-trailing-comma преди 5 години
types e5d6777211 Merge pull request #13628 from overleaf/ii-review-panel-migration-resolved-comments-entry преди 3 години
webpack-plugins 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 3 години
.eastrc 11ce07ec50 Merge pull request #1999 from overleaf/spd-migrations преди 7 години
.eslintignore 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 3 години
.eslintrc 510e686b7b Upgrade ESLint plugins (#13153) преди 3 години
.gitignore 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 3 години
.nvmrc cb8992e912 Merge pull request #12709 from overleaf/bg-rollback-additional-services преди 3 години
.prettierignore 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 3 години
.prettierrc 1be43911b4 Merge pull request #3942 from overleaf/prettier-trailing-comma преди 5 години
Dockerfile 13ea6b1860 Merge pull request #13566 from overleaf/ae-node-docker преди 3 години
Dockerfile.frontend 13ea6b1860 Merge pull request #13566 from overleaf/ae-node-docker преди 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 7bed264d16 Merge pull request #13455 from overleaf/ae-lint-tokens преди 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 d5dbca09df Merge pull request #13441 from overleaf/ae-downgrade-cypress преди 3 години
docker-compose.yml 13ea6b1860 Merge pull request #13566 from overleaf/ae-node-docker преди 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 67e7621633 Merge pull request #13572 from overleaf/mj-bibtex-grammar преди 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