README.md

React web UI for Availability

This is a React web app that consumes the GraphQL API provided by the code in server/. To get started you should probably read the React website.

It uses:

• The GraphQL protocol to talk to the server
• Apollo Client to manage interactions with GraphQL
• Redux to store state on the client
• Material-UI as the UI framework

Install

To get started you'll need to install NodeJS with your favourite package manager. Then install yarn:

npm install -g yarn

Now clone the repo and cd to web:

git clone ...
cd availability-poc/web

Install dependencies:

yarn

For a local dev server at localhost:5000, use:

yarn start

Deploy

For an optimized build for production

yarn build:prod

Contributing

Contributions of all kinds are welcomed but please attach screenshots to your pull requests showing new functionality and/or an explanation of what you did to verify your change doesn't cause a regression.

Please ensure commits that land on master are self-contained changes and easily revertable. This can be achieved through non-fast-forward pushes to PR branches for PRs that contain multiple commits or by using GitHub's squash and merge feature when you merge the PR.

CI/Travis must pass before a PR can be merged. We look for test coverage in all commits but do not require that codecov passes.