mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-25 11:16:31 -05:00
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# 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](https://yarnpkg.com/) 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](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.
|