Mirrors/pokeapi
2
0
Fork 0
mirror of https://github.com/PokeAPI/pokeapi synced 2024-09-20 06:01:54 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
38 commits 11 branches 8 tags 46 MiB
Python 97%
Shell 1.6%
Makefile 0.7%
JavaScript 0.4%
Go 0.2%
Find a file
phalt ba049cc936 Merge branch 'master' into rest-framework 
Conflicts:
	config/settings.py
	pokemon_v2/admin.py
	pokemon_v2/models.py
2015-04-11 11:05:59 +01:00
assets initial commit 2014-12-04 11:11:46 +00:00
config Merge branch 'master' into rest-framework 2015-04-11 11:05:59 +01:00
data Move Models 2015-04-09 00:45:23 -04:00
hits initial commit 2014-12-04 11:11:46 +00:00
pokemon remove xml for now 2014-12-15 10:13:52 +00:00
pokemon_v2 Merge branch 'master' into rest-framework 2015-04-11 11:05:59 +01:00
templates Adding a node-wrapper to the /docs pages 2015-04-04 13:01:55 -07:00
.gitignore live server update 2015-02-22 17:26:45 +00:00
CONTRIBUTORS.txt initial commit 2014-12-04 11:11:46 +00:00
LICENSE.rst initial commit 2014-12-04 11:11:46 +00:00
Makefile Progress - sprite resource implemented and testing 2015-03-11 20:07:30 +00:00
manage.py initial commit 2014-12-04 11:11:46 +00:00
README.md code 2014-12-05 12:32:36 +00:00
requirements.txt inital rest_framework progress 2015-02-22 17:11:40 +00:00

README.md

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.

See This blog post for more information.

Setup

  • Download this source code into a working directory.

  • Install the requirements using pip:

$ make install

This will install all the required packages and libraries for using PokeAPI

  • Set up the local developer environment using the following command:
$ make setup
  • Run the server using the following command::
$ make serve

Visit localhost:8000 to see the running website!

If you ever need to wipe the database use this command:

$ make wipe_db

Contributing

All contributions are welcome: bug fixes, data contributions, recommendations.

Please see the issues on GitHub before you submit a pull request or raise an issue, someone else might have beat you to it.

To contribute to this repository:

git clone git@github.com:<YOUR_USERNAME>/pokeapi.git
  • Create a new branch with a descriptive name:
git checkout -b my_new_branch

  • Write some code, fix something, and add a test to prove that it works. No pull request will be accepted without tests passing, or without new tests if new features are added.

  • Commit your code and push it to GitHub

  • Open a new pull request and describe the changes you have made.

  • We'll accept your changes after review.

Simple!