github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 03:06:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
199 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
renovate[bot] 17102d7d44
Update JS test packages (#296) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2020-06-27 11:55:27 +02:00
.github Add pull request template (#208) 2020-06-15 21:07:16 +02:00
.idea/dictionaries Add codimd to jetbrains dictionary (#235) 2020-06-20 16:47:30 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public Added click-to-load text for pdf embeddings and general option for texts on the embedding preview (#277) 2020-06-25 22:29:09 +02:00
src changed comment in markdown-renderer.scss file to explain why the usage of * is necessary 2020-06-27 11:23:22 +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 View mode wider (#271) 2020-06-25 22:38:10 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json Update JS test packages (#296) 2020-06-27 11:55:27 +02:00
README.md Add examples and cd command to README (#166) 2020-06-06 23:58:45 +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 JS test packages (#296) 2020-06-27 11:55:27 +02:00

README.md

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, 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.

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.