Null API

API For collecting data
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Benchmark
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This is a project to track stats on services I use

(back to top)

Built With

• Actix-Web
• SQLx
• Redis
• Reqwest

(back to top)

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.

• Postgres
• Redis
• Duolingo API Key
• Spotify API Key
• Github API Key

Installation

1. Clone the repo

   git clone https://github.com/thenulldev/api.git && cd api

2. Copy the .env.example

   cp .env.example .env

3. Run the API

   cargo run

Benchmark

1. Install Drill benchmarking suite

   cargo install drill

2. Run the API

   cargo run

3. Open a new terminal and run the benchmark

   drill --benchmark benchmark.yml --stats

(back to top)

Usage

This is mainly used to track my personal stats to display on a dashboard and for learning.

(back to top)

Roadmap

• Spotify Stats
• Duolingo Stats
• Github Stats
• Waka Stats

See the open issues for a full list of proposed features (and known issues).

(back to top)

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!

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

(back to top)

License

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

(back to top)

Contact

Stephen Freerking - @SnipeyDev - stephen@thenull.dev

Project Link: https://github.com/thenulldev/api

(back to top)