A simple Football API
⚠️ Wanna see a live preview of the API? Visit this link ⚠️
If you want to contribute, go ahead and fork it, togheter we can make it the best sports API in the world!
⚠️ The index design is pretty low, I made that and, as you can see, I’m not too good, it needs a restyle. If you are a front web developer and have some time, please fork it and fix that monster :D
As the title says, this is a small project that consists of a fast API to provide information about soccer teams or scorers in many leagues. You can get the full live ranking of one of the championships supported, get much information about a single squad, and more!
It consists of two parts: The data getting and the rest part to display it. In the /FootballScraper directory, you can find a file, called FootballScraper.py, that is the web scraper used to get the data from a famous Italian sports website called https://www.gazzetta.it/. Running that script will automatically get all the data that the API need, and will upload it into the SQL database. Instead, running the server.js file will start the node server for the proper data distribution. You can keep the web scraper file on to get live data in your DB, otherwise, you can use it whenever you want to refresh the data.
After downloading all the files, you will first need to set up the database. You will find the configuration file in the main directory, with the name of "FootballAPI.sql". Create a new database named "footballapi" and import the configuration file to set up everything. You will probably find some pre-filled data in the tables. These are old information, to get the right ones what we want to do is running the data scraper script, let's see how to do it.
First of all, you need to install python3, make sure it is installed properly by opening a cmd and typing the command python3. After this, navigate to the FootballScraper folder and try to run the command python3 FootballScraper.py. It will probably fail and return an error because you need to install all the right modules. To do so you need to run this 2 commands:
Now you can run the file and it will constantly update data until you stop it. To get the server to work you will need to install node.js. Run the command node to be sure it is installed properly, and then use the command node server.js to start the server. server.js is the main file that sets up a local server, while route.js is the file where all the routes and behaviors are stored. Now that the server is running you can open up your browser and type localhost:3000 and you will be redirected to the main index. The front end is built with a powerful and light framework called skeleton. Enjoy your new API.
That's all you need to know. If you find any bugs or have any suggestions, do not hesitate to contact me on telegram (@Giuliano_Crescimbeni), or follow me on twitter to get more contents and updates (@CrescimbeniG). Enjoy :D
Copyright (c) 2020 GiulianoCrescimbeni