Table of Contents
About The Project
This is a project to track stats on services I use
Built With
- Actix-Web
- SQLx
- Redis
- Reqwest
Getting Started
This is an example of how you can get started contributing.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
Installation
- Clone the repo
git clone https://github.com/thenulldev/api.git && cd api
- Copy the
.env.example
cp .env.example .env
- Run the API
cargo run
Benchmark
- Install Drill benchmarking suite
cargo install drill
- Run the API
cargo run
- Open a new terminal and run the benchmark
drill --benchmark benchmark.yml --stats
Usage
This is mainly used to track my personal stats to display on a dashboard and for learning.
Roadmap
- Spotify Stats
- Duolingo Stats
- Github Stats
- Waka Stats
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
Stephen Freerking - @SnipeyDev - [email protected]
Project Link: https://github.com/thenulldev/api