Intelli Telemetry

Table of Contents

• Build With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• RoadMap
• Contributing
• License
• Authors

Build With

The main Libraries/Frameworks/Language that i used to build this package

• Rust
• Tokio
• Axum
• Postgresql
• Redis

Getting Started

Prerequisites

• Rust
• Email Service
• Postgresql Database
• Redis Database

cargo run

Installation

Installation Command

git clone https://github.com/GPeaky/intelli-api.git

You need a .env to run the project. This is an example of what that .env should have

HOST=
REDIS_URL=
DATABASE_URL=
EMAIL_HOST=
EMAIL_FROM=
EMAIL_NAME=
EMAIL_PASS=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_REDIRECT_URI=
GOOGLE_GRANT_TYPE=

Usage

This project is created to provide a new solution to f1 leagues, to have real time data about their races sessions, Championship Manager, and everything about an F1 League. At the same time we want to give all for free

Documentation

RoadMap

See the open issues for list of proposed features and fix errors (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Authors

• Gerard Zinn - Gerard Zinn