github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-29 08:04:27 -05:00
Code Issues Projects Releases Packages Wiki Activity

Minor README improvements (#382)

Browse source 
* Improve README

Fixes some spelling mistakes, makes each bullet point to begin with a capital letter and clarifies some sentences.
This commit is contained in:
Erik Michelson 2020-08-04 21:29:17 +02:00 committed by GitHub
parent fe2f7403aa
commit 4054e130bb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,18 +1,19 @@
# CodiMD - React Client # CodiMD - React Client
![lint and build](https://github.com/codimd/react-client/workflows/lint%20and%20build/badge.svg)
![e2e](https://github.com/codimd/react-client/workflows/e2e/badge.svg) ![e2e](https://github.com/codimd/react-client/workflows/e2e/badge.svg)
This is the new, improved and better looking frontend for CodiMD 2.0. 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. Our goal is to recreate the current frontend in react and to improve it.
## Preparation ## 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. You'll need at least Node 10 (we recommend 12). We use [yarn](https://yarnpkg.com/) for our dependencies.
## Development mode ## Development mode
1. Clone this repo (e.g. `git clone https://github.com/codimd/react-client.git codimd-react-client`) 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`) 2. Go inside the repo (e.g. `cd codimd-react-client`)
3. run `yarn install` 3. Run `yarn install`
4. Either run 4. Either run
- `yarn start:dev` (expects [a server](https://github.com/codimd/server/tree/develop) running under [http://localhost:3000](http://localhost:3000)) - `yarn start:dev` (expects [a server](https://github.com/codimd/server/tree/develop) running under [http://localhost:3000](http://localhost:3000))
- `yarn start` (makes all api calls to the same domain the react-client runs on (normally [http://localhost:3001](http://localhost:3001) )) - `yarn start` (makes all api calls to the same domain the react-client runs on (normally [http://localhost:3001](http://localhost:3001) ))
@ -28,14 +29,14 @@ You will also see any lint errors in the console.
Unit testing is done via jest. Unit testing is done via jest.
1. run `yarn test` 1. Run `yarn test`
#### End2End #### End2End
We use [cypress](https://cypress.io) for e2e tests. We use [cypress](https://cypress.io) for e2e tests.
1. Run the frontend with `yarn start` 1. Start the frontend with `yarn start`
2. RUn `yarn cy:open` to open the cypress test loader 2. Run `yarn cy:open` to open the cypress test loader
3. Choose your browser and test 3. Choose your browser and test
4. Let the tests run 4. Let the tests run
@ -43,10 +44,10 @@ We use [cypress](https://cypress.io) for e2e tests.
1. Clone this repo (e.g. `git clone https://github.com/codimd/react-client.git codimd-react-client`) 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`) 2. Go inside the repo (e.g. `cd codimd-react-client`)
3. run `yarn install` 3. Run `yarn install`
4. run `yarn build` 4. Run `yarn build`
Builds the app for production to the `build` folder. Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance. 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. The build is minified and the filenames include a hash value of the content.