mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-22 17:56:30 -05:00
HedgeDoc - Ideas grow better together
c410a58573
* Added emoji-mart as emoji-picker * Fixed JSON to TypeScript-object parsing * added fork awesome to emoji-picker added ForkAwesomeIcons enum, because it's not possible to iterate over a typescript type consisting of strings [1]. This is a bit unfortunate since we now have two lists of all the fork awesome icons, but sadly it can not be done another way. added fork awesome as a custom category to the emoji picker. [1]: https://stackoverflow.com/questions/40863488/how-to-iterate-over-a-custom-literal-type-in-typescript * made picker close, when clicking away added react-use dependency for useClickAway hook * Fixed emoji-picker loading images from unpkg instead of using font * fixed addEmoji function added tests * Extract customIcons into useMemo Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Co-authored-by: Erik Michelson <github@erik.michelson.eu> Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> |
||
|---|---|---|
| .github | ||
| .idea/dictionaries | ||
| cypress | ||
| icon | ||
| public | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| CHANGELOG.md | ||
| cypress.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| tsconfig.json | ||
| yarn.lock | ||
CodiMD - React Client
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
- Clone this repo (e.g.
git clone https://github.com/codimd/react-client.git codimd-react-client) - Go inside the repo (e.g.
cd codimd-react-client) - Run
yarn install - Either run
yarn start:dev(expects a server running under http://localhost:3000)yarn start(makes all api calls to the same domain the react-client runs on (normally http://localhost:3001 ))
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.
- Run
yarn test
End2End
We use cypress for e2e tests.
- Start the frontend with
yarn start - Run
yarn cy:opento open the cypress test loader - Choose your browser and test
- Let the tests run
Production mode
- Clone this repo (e.g.
git clone https://github.com/codimd/react-client.git codimd-react-client) - Go inside the repo (e.g.
cd codimd-react-client) - Run
yarn install - 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.