HedgeDoc - Ideas grow better together
Find a file
Philip Molares ac00bc98c0
build new permissions modal (#532)
build new permissions modal

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-09-08 18:16:13 +02:00
.github
.idea/dictionaries
cypress
icon
public build new permissions modal (#532) 2020-09-08 18:16:13 +02:00
src build new permissions modal (#532) 2020-09-08 18:16:13 +02:00
.editorconfig
.gitignore
CHANGELOG.md
CONTRIBUTING.md
cypress.json
LICENSE
package.json Pin dependency cypress-commands to 1.1.0 2020-09-05 17:37:16 +02:00
README.md
renovate.json
tsconfig.json
yarn.lock Pin dependency cypress-commands to 1.1.0 2020-09-05 17:37:16 +02:00

HedgeDoc - React Client

lint and build e2e

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

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.