README.md

🇨🇦 🇬🇹 🇰🇷 🇱🇧 🇯🇵 Olympick 🏴󠁧󠁢󠁷󠁬󠁳󠁿 🇵🇰 🇮🇷 🇬🇧 🇨🇴

Currently there is no way to create a viewing schedule for the Olympics that only include specific sports. our Olympick app aims to solve this problem by helping people create their own personalised schedule for watching events of their favourite sports in UK time. Events already watched or no longer of interest can then be removed from schedules and/or new events can be added. A user is able to interract with the app either in the terminal, by running main.py, or in the browser by running app.py.

The project was inspired by this tweet, which one of us found:

Our app allows a user to :

Register or log in.

Input their favourite sports and receive a schedule of all the events happening for those sports.

Save favourite events of specific sports to a personalised schedule in UK time.

Remove events from their schedule if they are no longer interested in them.

Choose between running the app in terminal or browser

Tools

Python programming language

Git & GitHub

2020 Olympics Public API : (https://olypi.com/)

HTML5 to display schedules on the frontend

Flask for creating our API

bcrypt for hashing

SQL database

MySQL Connector to connect to our database with Python

Datetime library

Unit tests by mock and patch

Installation

1. Clone the source locally:

https://github.com/ellietms/Olympick

2. Run in your IDE of choice!
   Run main.py for our app in the terminal or app.py for our app in the browser

Demo

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT