github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 17:26:29 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
1672 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Tilman Vatteroth 880e542351
Add note loading boundary (#2040) 
* Remove redundant equal value

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

* Add NoteLoadingBoundary to fetch note from API before rendering

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

* Improve debug message for setHandler

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

* Add test for boundary

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

* Use common error page for note loading errors

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

* Fix tests

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

* Format code

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

* Add missing snapshot

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

* Reformat code

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-05-11 12:47:58 +02:00
.github Update Cypress browsers to node16.13.2-chrome100-ff98 2022-04-15 11:38:43 +02:00
.idea Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.netlify Add netlify deployments for PRs 2022-01-26 19:00:56 +01:00
.reuse Adapt react-client to use the real backend API (#1545) 2022-04-15 23:03:15 +02:00
.yarn/releases Update Yarn to v3.2.0 2022-02-27 19:46:15 +01:00
cypress Test multiple markdown extensions (#1886) 2022-04-27 09:59:01 +02:00
global-styles Import emojis from scss and work around emoji bug on macos 2021-12-30 23:14:12 +01:00
LICENSES Use yarn berry (#1726) 2021-12-30 18:45:04 +01:00
locales Add note loading boundary (#2040) 2022-05-11 12:47:58 +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 Add note loading boundary (#2040) 2022-05-11 12:47:58 +02:00
.editorconfig Adjust editor config (#976) 2021-02-03 22:13:04 +01:00
.env.development Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.env.development.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.env.production Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.env.production.license Disable inline runtime chunk 2021-07-07 16:41:15 +02:00
.env.test Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.env.test.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.eslintrc.json Remove redundant eslint imports 2022-03-28 20:30:05 +02:00
.eslintrc.json.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.gitattributes Use yarn berry (#1726) 2021-12-30 18:45:04 +01:00
.gitignore Add netlify deployments for PRs 2022-01-26 19:00:56 +01:00
.mailmap Change mailmap entry for "Tilman Vatteroth" 2021-04-01 13:55:27 +02:00
.mailmap.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
.nvmrc Update node to 16 2021-05-26 20:53:15 +02:00
.nvmrc.license Add license for nvmrc 2021-04-28 18:48:53 +02:00
.prettierignore Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.prettierignore.license Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.prettierrc.json Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.prettierrc.json.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
.yarnrc.yml Update Yarn to v3.2.0 2022-02-27 19:46:15 +01:00
AUTHORS.md Change my mail address 2021-08-26 23:21:49 +02:00
CHANGELOG.md New note creation (#1998) 2022-05-02 17:39:18 +02:00
CODE_OF_CONDUCT.md Add code of conduct 2022-01-11 20:56:18 +01:00
CONTRIBUTING.md Improve Logging (#1519) 2021-09-28 22:06:35 +02:00
cypress.json Parallel ci jobs (#1323) 2021-06-17 21:18:52 +02:00
cypress.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +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
jest.config.ts fix: uuid / jest export problem 2022-04-30 18:03:38 +02:00
LICENSE Change type of LICENSE 2021-03-25 21:55:44 +01:00
netlify.toml Add commit hash to version on netlify deployment (#1838) 2022-02-06 20:38:40 +01:00
next-env.d.ts Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
next-env.d.ts.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
next.config.js Disable react strict mode to prevent double rendering 2022-05-10 21:12:05 +02:00
package.json Update linters 2022-05-07 18:53:25 +02:00
package.json.license Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
README.md Fix duplicated badge in README 2022-04-15 00:09:49 +02:00
renovate.json Fix renovate match string for docker images 2022-02-12 23:41:54 +01:00
renovate.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
tsconfig.json Switch the base framework from Create React App to Next.JS 2021-12-30 14:43:25 +01:00
tsconfig.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
yarn.lock Lock file maintenance 2022-05-09 23:05:42 +02:00
yarn.lock.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00

README.md

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.