github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-25 15:41:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
338 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Philip Molares db4f2a4478
add missing autocompletions (#514) 
* added missing autocompletions:
- code-block
- container
- header
- image
- link
- pdf

* added extraTags ([name=], [time=], [color=]) to the link autocompletion, because they trigger on the same characters
added getUser in /redux/user/methods to retrive the current user outside of .tsx files
improve the regexps on several autocompletion

* renamed hints to auto
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-09-01 22:28:08 +02:00
.github Add 'yarn lint' command and run it in GH actions (#517) 2020-08-31 12:48:58 +02:00
.idea/dictionaries
cypress add missing autocompletions (#514) 2020-09-01 22:28:08 +02:00
icon
public Added flowchart diagrams (#510) 2020-08-29 23:56:27 +02:00
src add missing autocompletions (#514) 2020-09-01 22:28:08 +02:00
.editorconfig
.gitignore
CHANGELOG.md Feature/csv table (#500) 2020-08-29 15:55:42 +02:00
CONTRIBUTING.md
cypress.json
LICENSE
package.json Add 'yarn lint' command and run it in GH actions (#517) 2020-08-31 12:48:58 +02:00
README.md
renovate.json
tsconfig.json
yarn.lock Remove @types/react-bootstrap 2020-08-30 21:39:12 +02:00

README.md

CodiMD - React Client

lint and build 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 12. We use yarn for our dependencies.

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. Either run

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

End2End

We use cypress for e2e tests.

  1. Start 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 a hash value of the content.