github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 01:36:29 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
247 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Philip Molares d0fc96b929
rework how the frontend is started (#361) 
renamed frontend-config to api-url
renamed backend-config to config
removed api call to set frontend-config as the frontend either know where the backend is as it is delivered by it or get's this information via the enviroment variable REACT_APP_BACKEND
always start the client on Port 3001 as the backend will run on 3000 during development. changed the port on multiple occasions to accommodate for this
added package.json script 'start:dev'
changed README to better explain how to run backend and frontend side-by-side
2020-07-29 22:58:01 +02:00
.github Update dependency cypress to v4.11.0 (#340) 2020-07-25 13:59:56 +02:00
.idea/dictionaries Add codimd to jetbrains dictionary (#235) 2020-06-20 16:47:30 +02:00
cypress rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
src rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
.editorconfig better linting (#72) 2020-05-27 15:43:28 +02:00
.gitignore Add .idea directory to .gitignore (#362) 2020-07-28 22:21:42 +02:00
CHANGELOG.md Add support for image-proxies by (optional) piping of image urls through the backend (#315) 2020-07-29 22:28:32 +02:00
cypress.json rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
README.md rework how the frontend is started (#361) 2020-07-29 22:58:01 +02:00
renovate.json Updated test-class matching rule of renovate (#293) 2020-06-27 11:41:37 +02:00
tsconfig.json imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
yarn.lock Update dependency react-redux to v7.2.1 2020-07-25 21:24:02 +02:00

README.md

CodiMD - React Client

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 10 (we recommend 12). We use yarn for our dependencies, but npm can work too.

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. Run 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 the hashes.