HedgeDoc - Ideas grow better together
Find a file
Renovate Bot 072948b4c5 Update typescript-eslint monorepo to v4.9.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2020-12-12 13:02:04 +01:00
.github Use safer node_modules cache (#803) 2020-11-29 10:07:44 +01:00
.idea/dictionaries Added reuse information (#782) 2020-11-22 21:50:07 +01:00
.reuse fixed issues and pr templates 2020-11-23 19:49:29 +01:00
cypress Add custom language list for highlight js without 1c (#809) 2020-12-07 21:36:14 +01:00
LICENSES Add custom language list for highlight js without 1c (#809) 2020-12-07 21:36:14 +01:00
public added table overlay to table toolbar button. (#763) 2020-11-29 13:17:40 +01:00
src fixed table-picker.tsx (#836) 2020-12-11 23:41:07 +01:00
.editorconfig Added reuse information (#782) 2020-11-22 21:50:07 +01:00
.gitignore Ignore .eslintcache (#807) 2020-12-02 17:00:56 +01:00
.mailmap Added reuse information (#782) 2020-11-22 21:50:07 +01:00
.mailmap.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00
AUTHORS.md Added reuse information (#782) 2020-11-22 21:50:07 +01:00
CHANGELOG.md Add custom language list for highlight js without 1c (#809) 2020-12-07 21:36:14 +01:00
CONTRIBUTING.md Added reuse information (#782) 2020-11-22 21:50:07 +01:00
craco.config.js Added reuse information (#782) 2020-11-22 21:50:07 +01:00
cypress.json changed calls to cy.route to cy.intercept (#806) 2020-11-30 12:31:54 +01:00
cypress.json.license Added reuse information (#782) 2020-11-22 21:50:07 +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
package.json Update typescript-eslint monorepo to v4.9.1 2020-12-12 13:02:04 +01:00
package.json.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00
README.md Added reuse information (#782) 2020-11-22 21:50:07 +01:00
renovate.json Add new package group for markmap (#833) 2020-12-07 18:40:25 +01:00
renovate.json.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00
tsconfig.json Update multiple packages (#719) 2020-10-25 21:17:59 +01:00
tsconfig.json.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00
yarn.lock Update typescript-eslint monorepo to v4.9.1 2020-12-12 13:02:04 +01:00
yarn.lock.license Added reuse information (#782) 2020-11-22 21:50:07 +01:00

HedgeDoc - React Client

test, build e2e 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/codimd/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
  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/codimd/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

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include a hash value of the content.