pokeapi/README.md

44 lines
890 B
Markdown
Raw Normal View History

2014-12-04 11:11:46 +00:00
# PokeAPI
A RESTful API for Pokemon
LICENSE: BSD
http://pokeapi.co
## DEPRECATION
Quite a lot of data is missing from the V1 API.
**As of January 2015, no new data will be added to the v1 API, you will have to use the V2 API instead. This is part of an ongoing deprecation of the v1 API.**
2014-12-05 12:20:17 +00:00
See [This blog post for more information](http://phalt.co/if-you-have-data-they-will-consume-it).
2014-12-04 11:11:46 +00:00
## Setup
2014-12-04 12:11:57 +00:00
- Download this source code into a working directory.
2014-12-04 11:11:46 +00:00
2014-12-04 12:11:57 +00:00
- Install the requirements using pip:
```
$ make install
```
2014-12-04 11:11:46 +00:00
This will install all the required packages and libraries for using PokeAPI
2014-12-04 12:11:57 +00:00
- Set up the local developer environment using the following command:
```
$ make setup
```
- Run the server using the following command::
```
$ make serve
```
2014-12-04 11:11:46 +00:00
Visit localhost:8000 to see the running website!
2014-12-04 12:11:57 +00:00
If you ever need to wipe the database use this command:
```
$ make wipe_db
```