/MKBDVA4

Repository containing code for DV Assignment - Year 4 Sem 1 Assignment 4.

Primary LanguagePythonMIT LicenseMIT

MKBDVA4

Repository containing code for Assignment 4 of the course Data Visualisation - Year 4 Sem 1.

How to Run

  1. Clone the repo onto your local machine.
  2. Navigate to the root directory of the project.
  3. Run the command pip install -r requirements.txt to install all the dependencies for the visualisation.
  4. Run the app.py file by using the command python3 app.py / py app.py depending on the operating system you are using.
  5. Open the specified localhost link as provided on the terminal, on a web browser of your choice to view the visualisation.

Contributing to MKBDVA4

Hello and welcome! We are so glad that you are interested in contributing to MKBDVA4! We only have a couple of rules and we hope you enjoy the process :)

Contributing Rules

  1. Don't move or delete any files. Only modify them.

Contributing Process

  1. Fork the repository
  2. Clone your forked repository to your computer
  3. Head to the issues tab and look for an issue that you like.
  4. Once you have decided what issue to work on, give it a shot!
  5. Once done, push the code to your forked repository.
  6. Head to the Pull Requests tab and click on "Create New Pull Request"
  7. On the left of the arrow should be this repo and on the right should be yours.
  8. Add a small description to the Pull Request describing what you've done.
  9. Mention what Issue you have worked on. If the issue number is #3, you can mention "Closes #3" in the Pull Request description.
  10. Submit Pull Request

It's that easy! We hope you enjoy contributing to our repository. Don't hesitate to contact any of the maintainers about any problems!