github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-26 03:33:58 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
345 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Erik Michelson d597438c42
Add revisions dialog (#485) 
* Add mock files

Note that revisions-list needs to be called revisions in the reality to be confirm with the API spec, but our mocking solution doesn't allow that...

* Add revisions API calls

* Fix line endings in mock files

* Extend CommonModal to accept size and additionalClasses

* Clarify variable name in API request

* Add react-diff-viewer as dependency

* Add revision chooser modal

* Fix type of route params

* Added and updated mock files

* Added user-icon list per revision

* Added translation to alt text of avatars

* Updated mock file to remove inconsistencies

* Add caching for revisions

* Sort mock file revisions-list descending by timestamp

* Pre-select first/newest revision on first modal open

* Regenerated yarn.lock file from scratch

* Applied requested changes in variable names and line lengths

* User UserAvatar component instead of manually set image

* Move revision-modal-list-entry to own component

* Removed unnecessary return statements
2020-09-02 22:57:44 +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 Rename codimd to hedgedoc (#434) 2020-09-02 21:17:26 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public Add revisions dialog (#485) 2020-09-02 22:57:44 +02:00
src Add revisions dialog (#485) 2020-09-02 22:57:44 +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 Rename codimd to hedgedoc (#434) 2020-09-02 21:17:26 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md (#402) 2020-08-12 23:12:59 +02:00
cypress.json Use prod build for e2e tests (#432) 2020-08-19 22:43:56 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json Add revisions dialog (#485) 2020-09-02 22:57:44 +02:00
README.md Rename codimd to hedgedoc (#434) 2020-09-02 21:17:26 +02:00
renovate.json Add automerge config to renovatebot 2020-08-01 15:49:41 +02:00
tsconfig.json imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
yarn.lock Add revisions dialog (#485) 2020-09-02 22:57:44 +02:00

README.md

HedgeDoc - React Client

lint and build e2e

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

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.