HedgeDoc - Ideas grow better together
Find a file
Erik Michelson 85eff24be1
New note creation (#1998)
* Add new note page

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

* Make new note button clickable

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

* Add CHANGELOG note

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

* Refactor error messages

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

* Use features note in mock

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

* Common Error page should always use i18n

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-05-02 17:39:18 +02:00
.github Update Cypress browsers to node16.13.2-chrome100-ff98 2022-04-15 11:38:43 +02:00
.idea
.netlify
.reuse Adapt react-client to use the real backend API (#1545) 2022-04-15 23:03:15 +02:00
.yarn/releases
cypress Test multiple markdown extensions (#1886) 2022-04-27 09:59:01 +02:00
global-styles
LICENSES
locales New note creation (#1998) 2022-05-02 17:39:18 +02:00
netlify Adapt react-client to use the real backend API (#1545) 2022-04-15 23:03:15 +02:00
public Adapt react-client to use the real backend API (#1545) 2022-04-15 23:03:15 +02:00
src New note creation (#1998) 2022-05-02 17:39:18 +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
.mailmap.license
.nvmrc
.nvmrc.license
.prettierignore
.prettierignore.license
.prettierrc.json
.prettierrc.json.license
.yarnrc.yml
AUTHORS.md
CHANGELOG.md New note creation (#1998) 2022-05-02 17:39:18 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
cypress.json
cypress.json.license
developer-certificate-of-origin.txt
developer-certificate-of-origin.txt.license
jest.config.ts fix: uuid / jest export problem 2022-04-30 18:03:38 +02:00
LICENSE
netlify.toml
next-env.d.ts
next-env.d.ts.license
next.config.js
package.json Create store using redux-toolkit 2022-05-02 08:49:38 +02:00
package.json.license
README.md Fix duplicated badge in README 2022-04-15 00:09:49 +02:00
renovate.json
renovate.json.license
tsconfig.json
tsconfig.json.license
yarn.lock Lock file maintenance 2022-05-02 08:49:59 +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 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 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.