HedgeDoc - Ideas grow better together
Find a file
Renovate Bot 9797ab4215 Update linters to v4.30.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-09-04 15:26:16 +02:00
.github
.idea
.reuse Replace i18next-http-backend with i18next-resources-to-backend (#1466) 2021-08-31 20:40:33 +00:00
cypress
LICENSES
locales Replace i18next-http-backend with i18next-resources-to-backend (#1466) 2021-08-31 20:40:33 +00:00
public Replace i18next-http-backend with i18next-resources-to-backend (#1466) 2021-08-31 20:40:33 +00:00
src Move frontmatter extraction from renderer to redux (#1413) 2021-09-02 11:15:31 +02:00
.editorconfig
.env.production Disable inline runtime chunk 2021-07-07 16:41:15 +02:00
.env.production.license Disable inline runtime chunk 2021-07-07 16:41:15 +02:00
.gitignore
.mailmap
.mailmap.license
.nvmrc
.nvmrc.license
.prettierignore
.prettierignore.license
AUTHORS.md Change my mail address 2021-08-26 23:21:49 +02:00
CHANGELOG.md Replace custom gist implementation with github rendering (#1436) 2021-08-31 20:37:33 +00:00
check-build-env-vars.js
CONTRIBUTING.md Add codestyle docs (#1356) 2021-06-27 23:08:29 +02:00
craco.config.js
cypress.json
cypress.json.license
developer-certificate-of-origin.txt
developer-certificate-of-origin.txt.license
LICENSE
package.json Update linters to v4.30.0 2021-09-04 15:26:16 +02:00
package.json.license
README.md
renovate.json Remove "dependencyDashboard" from renovate config because it is already covered by "config:base" 2021-08-29 19:31:28 +02:00
renovate.json.license
tsconfig.json
tsconfig.json.license
yarn.lock Update linters to v4.30.0 2021-09-04 15:26:16 +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!