github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 19:26:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
321 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Erik Michelson db080e29d3
Fix editor being filled with €-symbols when pressing the editor-mode-shortcut (#493) 
This fix needs a little bit of explanation. Normally the 'keyUp' prevent is preferred because it fires after being sure, that not some buttons more belong to the shortcut. Additionally some platforms set the key-property of the 'keyDown'-event to the composition result of the key-combination thus resolving under certain environments to '€' while in other environments to 'e'.
The browser's event flow is as following: keyDown -> keyPress -> textInput -> keyUp.
As the keyUp-event is too late (after textinput) and the keyPress-event does not work properly with the modifiers, we felt compelled to use 'keyDown' and watch for 'e' as well as '€' key-properties. If some other keyboard locale does output different characters than these two, that person got a problem - meaning no functionality of the shortcut. But still better than nothing.
2020-08-27 14:32:06 +02:00
.github Use prod build for e2e tests (#432) 2020-08-19 22:43:56 +02:00
.idea/dictionaries Add codimd to jetbrains dictionary (#235) 2020-06-20 16:47:30 +02:00
cypress made the addCodeFences function also work without selections (#428) 2020-08-19 21:26:22 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public Restructure help dialog (#484) 2020-08-26 18:49:46 +02:00
src Fix editor being filled with €-symbols when pressing the editor-mode-shortcut (#493) 2020-08-27 14:32:06 +02:00
.editorconfig Change indentation for json files to 4 spaces and reformat json files 2020-08-15 22:53:44 +02:00
.gitignore Add .idea directory to .gitignore (#362) 2020-07-28 22:21:42 +02:00
CHANGELOG.md Restructure help dialog (#484) 2020-08-26 18:49:46 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md (#402) 2020-08-12 23:12:59 +02:00
cypress.json Use prod build for e2e tests (#432) 2020-08-19 22:43:56 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json Update dependency @testing-library/user-event to v12.1.2 (#480) 2020-08-23 01:50:08 +02:00
README.md Minor README improvements (#382) 2020-08-04 21:29:17 +02:00
renovate.json Add automerge config to renovatebot 2020-08-01 15:49:41 +02:00
tsconfig.json imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
yarn.lock Restructure help dialog (#484) 2020-08-26 18:49:46 +02:00

README.md

CodiMD - React Client

lint and build e2e

This is the new, improved and better looking frontend for CodiMD 2.0. Our goal is to recreate the current frontend in react and to improve it.

Preparation

You'll need at least Node 10 (we recommend 12). We use yarn for our dependencies.

Development mode

  1. Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
  2. Go inside the repo (e.g. cd codimd-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
  2. Run yarn cy:open to open the cypress test loader
  3. Choose your browser and test
  4. Let the tests run

Production mode

  1. Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
  2. Go inside the repo (e.g. cd codimd-react-client)
  3. Run yarn install
  4. Run yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include a hash value of the content.