github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 01:36:29 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
237 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Renovate Bot 5575df00c2 Update dependency highlight.js to v10.1.2
2020-07-25 18:03:40 +02:00
.github Update dependency cypress to v4.11.0 (#340) 2020-07-25 13:59:56 +02:00
.idea/dictionaries Add codimd to jetbrains dictionary (#235) 2020-06-20 16:47:30 +02:00
cypress Add YAML-metadata for notes and change the document title accordingly (#310) 2020-07-18 22:17:36 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public Add YAML-metadata for notes and change the document title accordingly (#310) 2020-07-18 22:17:36 +02:00
src Add key prop to asciinema 2020-07-21 21:16:55 +02:00
.editorconfig better linting (#72) 2020-05-27 15:43:28 +02:00
.gitignore imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
CHANGELOG.md Add Asciinema integration (#326) 2020-07-16 22:14:47 +02:00
cypress.json added e2e tests (#298) 2020-07-16 11:22:53 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json Update dependency highlight.js to v10.1.2 2020-07-25 18:03:40 +02:00
README.md readd toolbar (#302) 2020-07-16 11:34:56 +02:00
renovate.json Updated test-class matching rule of renovate (#293) 2020-06-27 11:41:37 +02:00
tsconfig.json imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
yarn.lock Update dependency highlight.js to v10.1.2 2020-07-25 18:03:40 +02:00

README.md

CodiMD - React Client

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, but npm can work too.

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. run yarn start

This should run the app in the development mode and open http://localhost:3000 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. yarn test

End2End

We use cypress for e2e tests.

  1. Run 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 the hashes.