Openrecord Front-End

The web application for the openrecord platform.

Local Development

Requirements

• Node.js >= 8.0.0
• Docker (and docker-compose)

npm install     # Install packages.
npm start       # Run the frontend using webpack-dev-server (with hot module replacement). Default address is http://localhost:8080

To develop locally against a working backend, use docker-compose:

docker-compose up -d      # Starts an instance of the openrecord api and a mysql server.

Configuration

Configuration is managed using node-config. All configuration options should go in the config/ directory.

Configs are inherited from default.yml initially. When NODE_ENV is set, a file matching [NODE_ENV].yml will be loaded (i.e. staging and production).

To override any configuration, add a file called local.yml (git-ignored) or map an environment variable to a configuration option in custom-environment-variables.yml.

Example configuration setup for API_PORT=1234 NODE_ENV=staging npm start: default.yml -> staging.yml -> local.yml -> local-staging.yml -> Environment Variables (API_PORT)

Tech

• React 16
• Redux 4
• Webpack 4
• Sass
• Styled Components
• Docker
• React Router + Redux
• [AWS Cloudfront] (https://aws.amazon.com/cloudfront/)