This repository is a personal public copy/fork of the upstream PokeAPI project. The original project README is preserved below for reference.
A RESTful API for Pokémon - pokeapi.co
Beta GraphQL support is rolling out! Check out the GraphQL paragraph for more info.
- Setup
- Database setup
- Docker and Compose
- GraphQL
- Kubernetes
- Wrappers
- Donations
- Join Us On Slack!
- Contributing
-
Download this source code into a working directory, be sure to use the flag
--recurse-submodulesto clone also our submodules. -
Install the requirements using pip:
make install # This will install all the required packages and libraries for using PokeAPI -
Set up the local development environment using the following command:
make setup
-
Run the server on port
8000using the following command:make serve
To build or rebuild the database by applying any CSV file update, run
make build-dbVisit localhost:8000/api/v2/ to see the running API!
Each time the build-db script is run, it will iterate over each table in the database, wipe it, and rewrite each row using the data found in data/v2/csv.
If you ever need to wipe the database use this command:
make wipe-sqlite-dbIf the database schema has changed, generate any outstanding migrations and apply them
make make-migrations