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

Add examples and cd command to README (#166)

Browse source 
Add examples and cd command to README
This commit is contained in:
mrdrogdrog 2020-06-06 23:58:45 +02:00 committed by GitHub
parent 575407ab6d
commit 772b099879
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -3,12 +3,15 @@
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
2. run `yarn install`
3. run `yarn start`
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.
@ -17,9 +20,10 @@ You will also see any lint errors in the console.
## Production mode
1. Clone this repo
2. run `yarn install`
3. run `yarn build`
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.