IDB

A software engineering project that provides an API for Rocket League, and a GUI for the data

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need to install docker and docker-compose for optimal development experience

Installing

Clone this repo Run

docker-compose build
docker-compose up -d

The application should be accessible from

http://localhost

and

http://localhost/api/

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Flask - Backend and API
React - Frontend
Bootstrap - Components
Traefik - Reverse Proxy

Contributing

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository

janabimustafa/IDB

IDB