Giter Club home page Giter Club logo

the-briefing-room-api's Introduction

The Briefing Room API

The Briefing Room is a web application designed by a passionate fan of F1. The goal of this app is to provide a platform where fellow enthusiasts can dive into the world of F1 racing through in-depth telemetry data analysis. You can explore historical race data, compare drivers' telemetry, and stay up-to-date with the latest race results and championship standings. This is a simple Flask API that serves the web app. โš™๏ธ

Tech used

  • Flask
  • This project wouldn't be possible without the amazing FastF1 package

Getting started

Prerequisites

  1. You'll need to have Python installed (3.x)

Installation

  1. Clone this repository with: git clone [email protected]:milan-codes/the-briefing-room-api.git
  2. Navigate to the folder and create a directory called datacache, which will cache the data received by FastF1: mkdir datacache
  3. Create a virtual environment for Flask: python3 -m venv venv
  4. Activate the virtual environment: source venv/bin/activate (use the script that'll work with your shell, the available scripts can be seen in venv/bin)
  5. Install the requirements recursively: pip3 install -r requirements.txt
  6. Start the dev server: python3 app.py

After stopping the server, you can deactivate the virtual environment by simply typing deactivate

Contributing

Contributions are welcomed! If you have coding skills, insights, or ideas to improve the app, you can actively participate in its development. Whether it's fixing bugs, adding new features, or suggesting improvements, your input can make a significant difference. Open an issue if you have any insights.

  • Note that only signed commits are accepted

Disclaimer

The creator of this project is in no way, shape or form linked to FORMULA 1, Liberty Media, the FIA or any other organization. This project was created only for fun, and educational purposes and it does not generate any revenue. All rights belong to their respective owners. Any insights or data derived from the app should be regarded as unofficial and for informational purposes only.

the-briefing-room-api's People

Contributors

milan-codes avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.