HedgeDoc - Ideas grow better together
Find a file
Tilman Vatteroth 0d480d509b
Replace source * pro files with npm package (#793)
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-29 10:08:27 +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 Fixed branding icon path in mocked cypress config (#804) 2020-11-28 23:59:17 +01:00
LICENSES Added reuse information (#782) 2020-11-22 21:50:07 +01:00
public fixed avatar url as we moved it in the reuse pr 2020-11-25 14:58:40 +01:00
src Replace source * pro files with npm package (#793) 2020-11-29 10:08:27 +01:00
.editorconfig Added reuse information (#782) 2020-11-22 21:50:07 +01:00
.gitignore Added reuse information (#782) 2020-11-22 21:50:07 +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 added remove notices to changelog (#757) 2020-11-23 12:04:58 +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 Use prod build for e2e tests (#432) 2020-08-19 22:43:56 +02: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 Replace source * pro files with npm package (#793) 2020-11-29 10:08:27 +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 added gitSignOff preset to renovate (#781) 2020-11-21 18:32:50 +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 Replace source * pro files with npm package (#793) 2020-11-29 10:08:27 +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.