HedgeDoc - Ideas grow better together
Find a file
renovate[bot] 6fd06ec957 chore(deps): lock file maintenance
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-11-07 13:36:43 +01:00
.github fix(workflow): Use pull request head SHA for checkout 2022-11-06 22:47:49 +01: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 Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00:00
.yarn chore(deps): update yarn to v3.2.4 2022-10-08 13:58:06 +02:00
cypress fix: remove race conditions in word-count e2e test 2022-11-06 19:51:11 +01:00
dev-reverse-proxy fix(docs): Restructure README.md 2022-10-02 22:36:01 +02:00
global-styles chores: Migrate react-bootstrap changes 2022-10-16 20:23:09 +02:00
LICENSES Use yarn berry (#1726) 2021-12-30 18:45:04 +01:00
locales fix(sidebar): Remove pdf export entry 2022-10-16 21:12:53 +02:00
netlify fix(ci): run workflows in target repository context 2022-11-03 22:01:04 +01:00
public Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00:00
src test: common modals (#2069) 2022-11-06 23:04:51 +01: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 Adjust editor config (#976) 2021-02-03 22:13:04 +01:00
.env.development Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00: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 Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00:00
.env.production.license Disable inline runtime chunk 2021-07-07 16:41:15 +02:00
.env.test Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00: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 Add eslint-plugin-prettier 2022-07-03 20:35:12 +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 to node v18 2022-06-16 10:58:05 +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 chore(deps): update yarn to v3.2.4 2022-10-08 13:58:06 +02:00
AUTHORS.md Change my mail address 2021-08-26 23:21:49 +02:00
CHANGELOG.md Remove markmap 2022-09-11 14:24:39 +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.config.ts Replace cypress.config.js with cypress.config.ts 2022-08-01 14:48:52 +02: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
Dockerfile Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00:00
jest.config.ts Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
LICENSE Change type of LICENSE 2021-03-25 21:55:44 +01:00
netlify.toml Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00: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 Refactor handling of environment variables (#2303) 2022-09-16 09:03:29 +00:00
package.json fix: revert next 13 update 2022-11-06 22:47:49 +01: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(docs): Restructure README.md 2022-10-02 22:36:01 +02:00
renovate.json fix(ci): fix regex manager name for node version 2022-11-03 22:19:14 +01:00
renovate.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
tsconfig.json Use yarn pnp as module linker (#2252) 2022-07-30 23:32:19 +02:00
tsconfig.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
yarn.lock chore(deps): lock file maintenance 2022-11-07 13:36:43 +01:00
yarn.lock.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00

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.

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.

Preparation

You need at least Node 14 (we recommend Node 18) and yarn. You MUST use yarn! There is no support for npm.

  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

Development mode

To start the development mode run yarn run dev. If not configured otherwise the development mode will run in mock-mode which emulates a hedgedoc backend. If you want to use the development with a real hedgedoc backend then run yarn run dev:for-real-backend instead. The app should run now and be available under http://localhost:3001 in your browser. In development mode the app will autoload changes you make to the code.

Production mode

Use yarn build to build the app in production mode and save it into the .next folder. The production build is minimized and optimized for best performance. Don't edit them by hand!

You can run the production build using the built-in server with yarn start. You MUST provide the environment variable HD_EDITOR_BASE_URL with protocol, domain and (if needed) path ( e.g. http://127.0.0.1:3001/) so the app knows under which URL it is available in the browser. Optionally you can also provide HD_RENDERER_BASE_URL if the renderer should use another domain than the editor. This is recommended for security reasons but not mandatory.

Production mock build

It is also possible to create a production build that uses the emulated backend by using yarn build:mock.

Using to backend and frontend together

To use backend and frontend together you'll need a reverse proxy that combines both services under one URL origin. We provide a configuration for caddy in the directory dev-reverse-proxy.

  1. Make sure that the backend is running on port 3000 (which is the default), and that HD_DOMAIN is set to http://localhost:8080.
  2. Start the frontend by using either running yarn dev:for-real-backend or by running a production build with HD_EDITOR_BASE_URL set to http://localhost:8080/.
  3. Start the reverse proxy. You can use the script run-caddy.sh in the dev-reverse-proxy directory or download a caddy binary from caddy and start it using caddy run.

Running 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 (or use a test build using yarn build:test which you can start using yarn start). The usage of :test is mandatory!
  2. Run yarn cy:open to open the cypress test loader
  3. Choose your browser and start a test suite

To run all tests in a headless browser use yarn cy:run:chrome or yarn cy:run:firefox

Bundle analysis

You can inspect the generated production-bundle files to look for optimization issues.

  1. run yarn analyze. This will overwrite any existing builds!
  2. Open the generated .next/server/analyze/server.html in your favourite browser