HedgeDoc - Ideas grow better together
Find a file
Renovate Bot 815e3f5bab Update dependency @fontsource/source-sans-pro to v4.3.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-08 22:12:34 +02:00
.github Restructures + New Evironment Variables (#1230) 2021-05-02 22:38:43 +02:00
.idea fixed copyright template for idea (#938) 2021-01-10 16:08:36 +01:00
.reuse Restructures + New Evironment Variables (#1230) 2021-05-02 22:38:43 +02:00
cypress Fix task list checkboxes for numbered lists (#1233) 2021-05-04 20:34:16 +02:00
LICENSES Reuse: Fix typo in HedgeDoc Icon Usage Guidelines (#1215) 2021-04-25 22:04:43 +02:00
public Fetch banner.txt from public URL instead of config (#1216) 2021-05-03 19:57:55 +00:00
src Change schema of url environment variables (#1237) 2021-05-05 22:33:30 +02:00
.editorconfig Adjust editor config (#976) 2021-02-03 22:13:04 +01:00
.gitignore Update dependency cypress to v7 (#1183) 2021-04-14 22:28:50 +02:00
.mailmap Change mailmap entry for "Tilman Vatteroth" 2021-04-01 13:55:27 +02:00
.mailmap.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
.nvmrc Add .nvmrc with node 15 2021-04-28 18:48:53 +02:00
.nvmrc.license Add license for nvmrc 2021-04-28 18:48:53 +02:00
AUTHORS.md Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
CHANGELOG.md The History PR: III - Editor integration (#1158) 2021-05-04 20:35:08 +02:00
check-build-env-vars.js Replace bash dependency with nodejs script (#1238) 2021-05-05 22:02:18 +02:00
CONTRIBUTING.md Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
craco.config.js Update dependency @craco/craco to v6.1.0 (#988) 2021-01-30 12:31:34 +00:00
cypress.json changed calls to cy.route to cy.intercept (#806) 2020-11-30 12:31:54 +01:00
cypress.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
developer-certificate-of-origin.txt added DCO (#764) 2020-11-22 10:06:53 +01:00
developer-certificate-of-origin.txt.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00
LICENSE Change type of LICENSE 2021-03-25 21:55:44 +01:00
package.json Update dependency @fontsource/source-sans-pro to v4.3.0 2021-05-08 22:12:34 +02:00
package.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
README.md Restructures + New Evironment Variables (#1230) 2021-05-02 22:38:43 +02:00
renovate.json Update dependency vega to v5.20.2 (#1152) 2021-04-10 15:27:42 +00:00
renovate.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
tsconfig.json The History PR: I - Move to redux (#1156) 2021-04-22 22:46:24 +02:00
tsconfig.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
yarn.lock Update dependency @fontsource/source-sans-pro to v4.3.0 2021-05-08 22:12:34 +02:00
yarn.lock.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00

HedgeDoc - React Client

test, build e2e lint lint

This is the new, improved and better looking frontend for HedgeDoc 2.0. Our goal is to recreate the current frontend in react and to improve it.

Preparation

You'll need at least Node 12. We use yarn for our dependencies.

Development mode

  1. Clone this repo (e.g. git clone https://github.com/hedgedoc/react-client.git hedgedoc-react-client)
  2. Go inside the repo (e.g. cd hedgedoc-react-client)
  3. Run yarn install
  4. Either run

This should run the app in the development mode and open http://localhost:3001 in your browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Tests

Unit

Unit testing is done via jest.

  1. Run yarn test

End2End

We use cypress for e2e tests.

  1. Start the frontend with yarn start:test in dev test mode or build a test build with yarn build:test which you can serve with yarn serve:build Don't use the regular start/build command, or the tests will fail!
  2. Run yarn cy:open to open the cypress test loader
  3. Choose your browser and test
  4. Let the tests run

Bundle analysis

You can inspect the generated production-bundle files to look for optimization issues.

  1. Run yarn analyze
  2. Open the generated build/report.html in your favourite browser

Production mode

  1. Clone this repo (e.g. git clone https://github.com/hedgedoc/react-client.git hedgedoc-react-client)
  2. Go inside the repo (e.g. cd hedgedoc-react-client)
  3. Run yarn install
  4. Run yarn build:production

This will build the app in production mode and save it into the build folder. The production build is optimized for best performance, minimized and the filenames include a hash value of the content. Don't edit them by hand!