github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-23 16:54:04 +00:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
441 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Erik Michelson 729ad652b3
Added markdown-file import (#645) 
* Added markdown-file import

* Reset file input after read, don't add unnecessary blank lines

* Add cypress-file-upload dependency

* Add cypress tests for md file importing

* Added CHANGELOG entry
2020-10-09 21:26:04 +02:00
.github Rename codimd to hedgedoc (#434) 2020-09-02 21:17:26 +02:00
.idea/dictionaries Rename codimd to hedgedoc (#434) 2020-09-02 21:17:26 +02:00
cypress Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00
icon
public Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00
src Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00
.editorconfig Change indentation for json files to 4 spaces and reformat json files 2020-08-15 22:53:44 +02:00
.gitignore Fix missed code (#530) 2020-09-02 21:57:31 +02:00
CHANGELOG.md Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md (#402) 2020-08-12 23:12:59 +02:00
craco.config.js Add webpack-bundle-analyzer as dev-tool (#591) 2020-09-20 23:22:37 +02:00
cypress.json Use prod build for e2e tests (#432) 2020-08-19 22:43:56 +02:00
LICENSE
package.json Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00
README.md Add webpack-bundle-analyzer as dev-tool (#591) 2020-09-20 23:22:37 +02:00
renovate.json
tsconfig.json
yarn.lock Added markdown-file import (#645) 2020-10-09 21:26:04 +02:00

README.md

HedgeDoc - React Client

test, build e2e lint

This is the new, improved and better looking frontend for HedgeDoc 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 hedgedoc-react-client)
  2. Go inside the repo (e.g. cd hedgedoc-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

Bundle analysis

You can inspect the generated production-bundle files to look for optimization issues.

  1. Run yarn analyze
  2. Open the generated build/report.html in your favourite browser

Production mode

  1. Clone this repo (e.g. git clone https://github.com/codimd/react-client.git hedgedoc-react-client)
  2. Go inside the repo (e.g. cd hedgedoc-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.