https://github.com/zeenix/pokeserve

Pokemon descriptions in Shakespeare style
https://github.com/zeenix/pokeserve

Last synced: about 1 month ago
JSON representation

Pokemon descriptions in Shakespeare style

• Host: GitHub
• URL: https://github.com/zeenix/pokeserve
• Owner: zeenix
• Created: 2021-03-07T23:58:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T21:29:30.000Z (over 3 years ago)
• Last Synced: 2023-04-11T13:50:55.968Z (over 1 year ago)
• Language: Rust
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pokeserv

A fun API server that provides descriptions of given Pokemon in Shakespeare style. It relies on two

services:

* pokeapi.co

* funtranslations.com/api/shakespeare

## The API

Once the server is up, the API endpoint is available `http://HOSTNAME:3000/pokemon/POKEMON_NAME`.

For example here is an sample query sent from the same machine as the one Pokeserv is running on,

along with their results:

```console

$ curl http://localhost:3000/pokemon/charizard

{"name":"charizard","description":"Spits fire yond is hot enow to melt boulders. Known to cause forest fires unintentionally."}

$ curl http://localhost:3000/pokemon/butterfree

{"name":"butterfree","description":"In hurlyburly,  't flaps its wings at high speed to release highly toxic dust into the air."}

```

# Building and running from source code

Pokeserv is written in Rust and as such it uses Cargo as its build system. To install the needed

build tools, simply run the following in your terminal, then follow the onscreen instructions:

```sh

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

```

After that, you can build and run Pokeserv with this command:

```sh

cargo run

```

Pokeserv is now up and ready to server requests from all network interfaces.

# Building a docker image

A docker image can be built through the usual command:

```sh

docker build -t pokeserve .

```

And to run pokeserve after:

```sh

docker run -p 3000:3000 pokeserve

```

## TODO

* See if there is a better pokeapi.co endpoint to get the Pokemon description than the one we're

  using. See FIXME in `src/poke.rs` file.

* Make it possible to configure through commandline arguments and environment variables:

  * Port and IP to host on.

  * API keys for the used services.

* Use HTTPS instead of HTTP.

* Add logging.

* The Dockerfile is very basic and can be improved in many ways, for example speed of rebuilds and

  image size.

* Most importly: Rename to something better. Pokemonspear? :)