HedgeDoc - Ideas grow better together
Find a file
renovate[bot] 6f2b0f873f
Update CodeMirror (#2265)
* Update CodeMirror

Signed-off-by: Renovate Bot <bot@renovateapp.com>

* Fix yarn.lock

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-08-06 20:08:42 +02:00
.github Update actions/cache action to v3.0.6 (#2266) 2022-08-06 16:49:02 +02:00
.idea
.netlify
.reuse
.yarn
cypress feat: add linter and linterGutter (#2237) 2022-07-31 18:25:03 +02:00
docker
global-styles Remove roman line numbers (#2239) 2022-07-31 01:02:36 +02:00
LICENSES
locales feat: add linter and linterGutter (#2237) 2022-07-31 18:25:03 +02:00
netlify Update dependency netlify-cli to v10.15.0 (#2271) 2022-08-06 16:51:07 +02:00
public
src feat: add spell check (#2236) 2022-08-04 19:57:19 +02:00
.dockerignore Add dockerignore 2022-08-01 15:51:57 +02:00
.dockerignore.license Add docker ignore license 2022-08-01 15:51:57 +02:00
.editorconfig
.env.development
.env.development.license
.env.production
.env.production.license
.env.test
.env.test.license
.eslintrc.json
.eslintrc.json.license
.gitattributes
.gitignore
.mailmap Change mailmap entry for "Tilman Vatteroth" 2021-04-01 13:55:27 +02:00
.mailmap.license
.nvmrc
.nvmrc.license
.prettierignore
.prettierignore.license
.prettierrc.json
.prettierrc.json.license
.yarnrc.yml Use node-modules linker 2022-08-01 14:48:52 +02:00
AUTHORS.md
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
cypress.config.ts Replace cypress.config.js with cypress.config.ts 2022-08-01 14:48:52 +02:00
developer-certificate-of-origin.txt
developer-certificate-of-origin.txt.license
Dockerfile add port 2022-08-01 15:51:57 +02:00
jest.config.ts Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
LICENSE
netlify.toml
next-env.d.ts
next-env.d.ts.license
next.config.js Disable double caching of dependencies in dockerfile 2022-08-01 15:51:57 +02:00
package.json Update CodeMirror (#2265) 2022-08-06 20:08:42 +02:00
package.json.license
README.md Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
renovate.json Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
renovate.json.license
tsconfig.json Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
tsconfig.json.license
yarn.lock Update CodeMirror (#2265) 2022-08-06 20:08:42 +02:00
yarn.lock.license

HedgeDoc - React Client

test, build e2e lint Language grade: JavaScript Total alerts

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 14 (we recommend Node 18) and yarn. You MUST use yarn! There is no support for npm.

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 dev: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 .next/server/analyze/server.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

This will build the app in production mode and save it into the .next 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!

You can run the production build using the built-in server with yarn start.

UI Test

Curious about the new look and feel? We provide a demo of the new UI on hedgedoc.dev. This version uses mocked data and has no data persistence.

The UI test is hosted by netlify. Please check their privacy policy as well as ours.