github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-23 16:22:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
1287 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Tilman Vatteroth e9defd60dc
Restructure click shield (#1611) 
* Rename one-click-embedding to click shield
* Removes the static fallback image from the vimeo frame. The set URL is broken.
* Adds the ability to define background colors for the click shield background


Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-11-14 18:44:55 +01:00
.github Use renovate to update cypress image 2021-10-16 17:08:35 +02:00
.idea Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02:00
.reuse Replace i18next-http-backend with i18next-resources-to-backend (#1466) 2021-08-31 20:40:33 +00:00
cypress Restructure click shield (#1611) 2021-11-14 18:44:55 +01:00
LICENSES Remove unused licenses 2021-06-12 17:04:09 +02:00
locales Restructure click shield (#1611) 2021-11-14 18:44:55 +01:00
public Use "untitled" fallback in history entry without title (#1546) 2021-10-24 21:08:28 +02:00
src Restructure click shield (#1611) 2021-11-14 18:44:55 +01:00
.editorconfig Adjust editor config (#976) 2021-02-03 22:13:04 +01:00
.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 Add prettier for codestyle and re-format everything (#1294) 2021-06-06 23:14:00 +02: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
AUTHORS.md Change my mail address 2021-08-26 23:21:49 +02:00
CHANGELOG.md Change dead FAQ link to relevant GH issue (#1613) 2021-11-11 20:40:06 +00:00
check-build-env-vars.js Replace bash dependency with nodejs script (#1238) 2021-05-05 22:02:18 +02:00
CONTRIBUTING.md Improve Logging (#1519) 2021-09-28 22:06:35 +02:00
craco.config.js Replace emojibase-data with emoji-picker-element-data (#1293) 2021-06-05 22:16:46 +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
LICENSE Change type of LICENSE 2021-03-25 21:55:44 +01:00
package.json Update definitely typed 2021-11-14 14:02:41 +01:00
package.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
README.md Add LGTM badges to README.md (#1534) 2021-10-07 21:19:07 +02:00
renovate.json Use renovate to update cypress image 2021-10-16 17:08:35 +02:00
renovate.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
tsconfig.json The History PR: I - Move to redux (#1156) 2021-04-22 22:46:24 +02:00
tsconfig.json.license Change copyright year from 2020 to 2021 (#917) 2021-01-06 21:37:59 +01:00
yarn.lock Update definitely typed 2021-11-14 14:02:41 +01: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 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 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!