Skip to content

An API which compiles pokemon data from different sources into a combined and richer format for local use.

License

Notifications You must be signed in to change notification settings

Zitronenjoghurt/pokedata-api

Repository files navigation

Rust codecov

Pokedata API (work in progress)

An API which compiles pokemon data from different sources into a combined and richer format for local use.

Setup

The API will automatically download and prepare data from different data sources during the build process. After being built, the pokemon data is bundled into the binary and is independent from all outside data sources. If there was an update to the remote data, just delete the data directory in the project root and rebuild the app.

Automatic data updates are planned for the future.

Pre-requisites

  • Rust
  • Git

Step-by-Step

Clone the repository:

git clone https://github.com/Zitronenjoghurt/pokedata-api.git

Navigate to the project directory and then:

cargo run

Visit your preferred documentation style:

http://localhost:3000/docs
http://localhost:3000/rapidoc
http://localhost:3000/swagger

About

An API which compiles pokemon data from different sources into a combined and richer format for local use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages