marquezmiko / F1DriverCompare

Personal project utilizing F1 API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MIT License LinkedIn


Logo

F1 Driver Compare

A fun way to compare stats of your favorite F1 drivers.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Ever wanted to compare the performance of multiple drivers across multiple races? This quick webpage helps easily visualize the data from an F1 history database.

This project follows the following data flow:

  • User interaction within React components built on Javascript and Typescript
  • API interaction utilizing server code built on NodeJS
  • Asynchronous calls utilizing promise-based calls

(back to top)

Built With

Full stack development completed with:

  • React.js
  • NodeJS
  • babel

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

No API key needed! Follow installation instructinos.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  2. Install NPM packages
    npm install
  3. Begin the server
    npm run server-dev
    Take note of the server port noted.
  4. Begin the client side
    npm run react-dev
  5. In a browser, navigate to localhost://

(back to top)

Usage

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Driver Year Selection
  • Add Social Media Links

(back to top)

License

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

(back to top)

Contact

Miko Marquez - marquezmiko@gmail.com

Project Link: https://github.com/marquezmiko/rppo2204-mvp

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Personal project utilizing F1 API


Languages

Language:JavaScript 100.0%