Open Webslides

React app for the OpenWebslides open-source co-creation platform.

How to...

• Run the webpack dev server: yarn run dev-server
• Run the webpack dev server using a non-default API server: yarn run dev-server --env.API_URL=http://my-server.com/api
• Run tests:
  • Minimal output: yarn run test
  • Verbose test output + coverage report: yarn run test-report
• Run ESLint check: yarn run lint
• Run Flow check: yarn run flow

Note on pre-commit & pre-push hooks

package.json contains a precommit and a prepush script, which are automatically executed on git commit / push using Husky. They can also be executed manually using yarn run precommit and yarn run prepush, respectively.

The following checks need to pass in order for a commit to succeed:

• Code contains no eslint errors
• Code contains no flow errors

The following checks need to pass in order for a push to succeed:

• There are no failing tests

Note on flow-typed

Please keep this up-to-date by running flow-typed install every time package.json is updated.

Good to read:

• Flow for React docs
• Three rules for structuring (Redux) applications