HedgeDoc - Ideas grow better together
Find a file
Renovate Bot 1eb468e746 Update dependency mermaid to v8.11.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-06 21:35:47 +02:00
.github Don't rebuild commits in e2e 2021-06-23 20:12:59 +02:00
.idea Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.reuse Restructures + New Evironment Variables (#1230) 2021-05-02 22:38:43 +02:00
cypress Fix Splitter issues (#1343) 2021-06-21 23:13:39 +02:00
LICENSES Remove unused licenses 2021-06-12 17:04:09 +02:00
public Add word count in document info modal (#738) 2021-06-17 22:31:28 +02:00
src Use IframeEditorToRendererCommunicatorContextProvider in document read only mode 2021-06-23 13:12:43 +02:00
.editorconfig
.gitignore Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.mailmap Change mailmap entry for "Tilman Vatteroth" 2021-04-01 13:55:27 +02:00
.mailmap.license
.nvmrc Update node to 16 2021-05-26 20:53:15 +02:00
.nvmrc.license Add license for nvmrc 2021-04-28 18:48:53 +02:00
.prettierignore Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.prettierignore.license Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
AUTHORS.md
CHANGELOG.md Add word count in document info modal (#738) 2021-06-17 22:31:28 +02:00
check-build-env-vars.js Replace bash dependency with nodejs script (#1238) 2021-05-05 22:02:18 +02:00
CONTRIBUTING.md Add codestyle docs (#1356) 2021-06-27 23:08:29 +02:00
craco.config.js Replace emojibase-data with emoji-picker-element-data (#1293) 2021-06-05 22:16:46 +02:00
cypress.json Parallel ci jobs (#1323) 2021-06-17 21:18:52 +02:00
cypress.json.license
developer-certificate-of-origin.txt
developer-certificate-of-origin.txt.license
LICENSE Change type of LICENSE 2021-03-25 21:55:44 +01:00
package.json Update dependency mermaid to v8.11.0 2021-07-06 21:35:47 +02:00
package.json.license
README.md Update node to 16 2021-05-26 20:53:15 +02:00
renovate.json Activate renovate dependency dashboard 2021-05-31 21:33:42 +02:00
renovate.json.license
tsconfig.json The History PR: I - Move to redux (#1156) 2021-04-22 22:46:24 +02:00
tsconfig.json.license
yarn.lock Update dependency mermaid to v8.11.0 2021-07-06 21:35:47 +02:00
yarn.lock.license

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 need at least Node 12 (we recommend Node 16) and yarn.

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!