Business Activity Visualiser (frontend)

A web application to visualise the UK Office of National Statistics (ONS) data on business enterprises by UK country, region, county, or district.

• See the demo deployed here.
• Deployed along with the backend repository available here.

Built With

• React.js
• TypeScript
• Mapbox GL JS

Getting Started

Prerequisites

1. node
2. npm

Installation:

1. Install and run the backend repository locally as described here.
2. Then clone this repo and install it.
   git clone https://github.com/syedtaqi95/business-activity-frontend.git
cd business-activity-frontend && npm install \

Run the project locally:

npm start

Then visit http://localhost:3000/

Note: you need to run the backend repo on http://localhost:8000 in order to load map data.

Build the project:

npm run build

Project Structure

• public: contains the static assets
• src: top level folder for the React app
  • components: contains the React components
  • services: services to communicate with the backend
  • utils: utilities directory

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Syed Taqi Haider - www.github.com/syedtaqi95
Joel Edwardson - www.github.com/joeledwardson