mirror of
https://github.com/PokeAPI/pokeapi
synced 2024-09-20 06:01:54 +00:00
docs: update docker-compose/beautify
This commit is contained in:
Naramsim
Alessandro Pezzè
parent
647e9ce6fd
commit
88eda9fa19
1 changed files with 82 additions and 71 deletions
153
README.md
153
README.md
|
|
@ -1,34 +1,30 @@
|
|||
# PokeAPI
|
||||
# PokéAPI [](https://circleci.com/gh/PokeAPI/pokeapi) [](https://github.com/PokeAPI/pokeapi/blob/master/LICENSE.rst)
|
||||
|
||||
A RESTful API for Pokémon
|
||||
[](#backers) [](#sponsors)
|
||||
|
||||
LICENSE: [BSD](https://github.com/PokeAPI/pokeapi/blob/master/LICENSE.rst)
|
||||
|
||||
http://pokeapi.co
|
||||
|
||||
[](#backers) [](#sponsors) [](https://ghit.me/repo/PokeAPI/pokeapi)
|
||||
A RESTful API for Pokémons - [pokeapi.co](http://pokeapi.co)
|
||||
|
||||
## Fair use policy
|
||||
|
||||
PokéAPI is open and free to use. However, we will ban IP addresses that abuse this privilege. This API is used primarily for educational purposes, and we do not want people inhibiting the education of others. See the fair use guide on the docs for more information. Moreover, we strongly suggest to cache request made, see the [Wrapper section](#official-wrappers) below.
|
||||
|
||||
## Join Us On Slack!
|
||||
|
||||
Have a question or just want to discuss new ideas and improvements? Hit us up on slack. Consider talking with us here before creating new issue.
|
||||
This way we can keep issues here a bit more organized and helpful in the long run. Be excellent to eachother :)
|
||||
This way we can keep issues here a bit more organized and helpful in the long run. Be excellent to each other :smile:
|
||||
|
||||
[Sign up easily](https://pokeapi-slack-invite.herokuapp.com/)!
|
||||
|
||||
Once you've signed up visit [PokeAPI on Slack](https://pokeapi.slack.com)
|
||||
Once you've signed up visit [PokéAPI on Slack](https://pokeapi.slack.com)
|
||||
|
||||
## Donations
|
||||
|
||||
Help to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a $10 donation to help keep the server up. We get over 2 million requests a month and it's quite costly!
|
||||
|
||||
Thank you to all our backers! [[Become a backer](https://opencollective.com/pokeapi#backer)]
|
||||
Thank you to all our backers! [Become a backer](https://opencollective.com/pokeapi#backer)
|
||||
|
||||
<a href="https://opencollective.com/pokeapi#backers" target="_blank"><img src="https://opencollective.com/pokeapi/backers.svg?width=890"></a>
|
||||
|
||||
|
||||
## Sponsors
|
||||
|
||||
Ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/pokeapi#sponsor).
|
||||
|
|
@ -49,107 +45,114 @@ Ask your company to also support this open source project by [becoming a sponsor
|
|||
* Node server-side [PokeAPI/pokedex-promise-v2](https://github.com/PokeAPI/pokedex-promise-v2) | _Auto caching_
|
||||
* Browser client-side [PokeAPI/pokeapi-js-wrapper](https://github.com/PokeAPI/pokeapi-js-wrapper) | _Auto caching_
|
||||
* Java/Kotlin [PokeAPI/pokekotlin](https://github.com/PokeAPI/pokekotlin)
|
||||
* Python [GregHilmes/pokebase](https://github.com/GregHilmes/pokebase) | _Auto caching_
|
||||
* Python V1 APIs [PokeAPI/pykemon](https://github.com/PokeAPI/pykemon)
|
||||
* Python 3 [GregHilmes/pokebase](https://github.com/GregHilmes/pokebase) | _Auto caching_
|
||||
* Python [PokeAPI/pykemon](https://github.com/PokeAPI/pykemon)
|
||||
* PHP [lmerotta/phpokeapi](https://github.com/lmerotta/phpokeapi) | _Auto caching, lazy-loading_
|
||||
|
||||
## DEPRECATION
|
||||
|
||||
**As of October 2018, the v1 API has been removed from PokéAPI.** For more information, see [pokeapi.co/docs/v1.html](https://pokeapi.co/docs/v1.html).
|
||||
|
||||
## Setup [](https://www.python.org/download/releases/3.7/)
|
||||
|
||||
- Download this source code into a working directory.
|
||||
|
||||
- Install the requirements using pip:
|
||||
|
||||
```sh
|
||||
make install
|
||||
```
|
||||
$ make install
|
||||
```
|
||||
|
||||
This will install all the required packages and libraries for using PokeAPI
|
||||
|
||||
- Set up the local developer environment using the following command:
|
||||
|
||||
```sh
|
||||
make setup
|
||||
```
|
||||
$ make setup
|
||||
```
|
||||
- Run the server using the following command::
|
||||
```
|
||||
$ make serve
|
||||
|
||||
- Run the server using the following command:
|
||||
|
||||
```sh
|
||||
make serve
|
||||
```
|
||||
|
||||
Visit localhost:8000 to see the running website!
|
||||
|
||||
If you ever need to wipe the database use this command:
|
||||
```
|
||||
$ make wipe_db
|
||||
|
||||
```sh
|
||||
make wipe_db
|
||||
```
|
||||
|
||||
## Database setup
|
||||
|
||||
Start Django shell
|
||||
```
|
||||
$ python manage.py shell --settings=config.local
|
||||
|
||||
```sh
|
||||
python manage.py shell --settings=config.local
|
||||
```
|
||||
|
||||
Run the build script with
|
||||
|
||||
```py
|
||||
from data.v2.build import build_all
|
||||
build_all()
|
||||
```
|
||||
$ from data.v2.build import build_all
|
||||
$ build_all()
|
||||
```
|
||||
|
||||
Each time the build 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.
|
||||
|
||||
In informal tests on a Windows PC with a SSD and a 2.50 GHz processor, building against a PostgresQL database took approximately 6 minutes, and building against a SQLite database took about 7.5 minutes or longer, with some varying results.
|
||||
|
||||
The option to build individual portions of the database was removed in order to increase performance of the build script.
|
||||
|
||||
|
||||
## Docker
|
||||
|
||||
The application can be built and run as a Docker container for easy deployments
|
||||
|
||||
From the root directory of the cloned repo
|
||||
```
|
||||
docker build -t pokeapi .
|
||||
```
|
||||
|
||||
Run the container on host port 8000
|
||||
```
|
||||
docker run -d -p 8000:8000 pokeapi
|
||||
```
|
||||
|
||||
|
||||
## Docker Compose
|
||||
|
||||
There is also a multi-container setup, managed by [Docker Compose](https://docs.docker.com/compose/). This setup allow you to deploy a production-like environment, with separate containers for each services.
|
||||
|
||||
Create data volumes for Redis and Postgres
|
||||
```
|
||||
docker volume create --name=redis_data
|
||||
docker volume create --name=pg_data
|
||||
Start the process using
|
||||
|
||||
```sh
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
Start the process using
|
||||
```
|
||||
docker-compose up
|
||||
```
|
||||
You can specify the ```-d``` switch to start in detached mode.
|
||||
This will bind port 80 and 443. Unfortunately, unlike the ```docker``` command, there is no command line arguments to specify ports. If you want to change them, edit the ```docker-compose.yml``` file.
|
||||
You can specify the `-d` switch to start in detached mode.
|
||||
This will bind port 80 and 443. Unfortunately, unlike the `docker` command, there is no command line arguments to specify ports. If you want to change them, edit the `docker-compose.yml` file.
|
||||
|
||||
After that, start the migration process
|
||||
```
|
||||
docker-compose exec app python manage.py migrate
|
||||
|
||||
```sh
|
||||
python manage.py migrate --settings=config.docker-compose
|
||||
```
|
||||
|
||||
And then, import the data using the shell
|
||||
```
|
||||
docker-compose exec app python manage.py shell
|
||||
|
||||
```sh
|
||||
python manage.py shell --settings=config.docker-compose
|
||||
```
|
||||
|
||||
You can use the ```build_all()``` method, or individuals data building functions (See _V2 Database setup_)
|
||||
```
|
||||
You can use the `build_all()` method, or individuals data building functions (See _V2 Database setup_)
|
||||
|
||||
```py
|
||||
from data.v2.build import build_all
|
||||
build_all()
|
||||
```
|
||||
|
||||
For the moment, this setup doesn't allow you to use the ```scale``` command.
|
||||
Browse [localhost/api/v2/](http://localhost/api/v2/) or [localhost/api/v2/pokemon/bulbasaur/](http://localhost/api/v2/pokemon/bulbasaur/)
|
||||
|
||||
For the moment, this setup doesn't allow you to use the `scale` command.
|
||||
|
||||
## Docker (obsolete)
|
||||
|
||||
The application can be built and run as a Docker container for easy deployments
|
||||
|
||||
From the root directory of the cloned repo
|
||||
|
||||
```sh
|
||||
docker build -t pokeapi .
|
||||
```
|
||||
|
||||
Run the container on host port 8000
|
||||
|
||||
```sh
|
||||
docker run -d -p 8000:8000 pokeapi
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -165,14 +168,18 @@ To contribute to this repository:
|
|||
- [Fork the project to your own GitHub profile](https://help.github.com/articles/fork-a-repo/)
|
||||
|
||||
- Download the project using git clone:
|
||||
```
|
||||
git clone git@github.com:<YOUR_USERNAME>/pokeapi.git
|
||||
```
|
||||
|
||||
```sh
|
||||
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.**
|
||||
|
||||
```sh
|
||||
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
|
||||
|
||||
|
|
@ -181,3 +188,7 @@ git checkout -b my_new_branch
|
|||
- We'll accept your changes after review.
|
||||
|
||||
Simple!
|
||||
|
||||
## DEPRECATION
|
||||
|
||||
As of October 2018, the v1 API has been removed from PokéAPI. For more information, see [pokeapi.co/docs/v1.html](https://pokeapi.co/docs/v1.html).
|
||||
Loading…
Reference in a new issue