thepra/Pokespearean
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update 'README.md'

Browse Source 
Adding more instructions for running it.
This commit is contained in:
Eugene ;)
2020-11-22 19:06:45 +01:00
parent 2ad60c5257
commit a9b4f9256a
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,3 +1,18 @@
# Pokespearean
Pokemon description API as if it was told by Shakespeare
Pokemon description API as if it was written by Shakespeare.
## How to run it
The project that needs to be run should be the one named `Pokespearean`.
The project should be run using Visual Studio 2019(VS).
The project has 3 running profiles:
1. IIS Express
2. Pokespearean
3. Docker
The first 2 profiles will run the project directly(clicking on the green play button in VS), opening a browser window at `http://localhost:5000`.
In this case you need to add to the path "/pokemon/{pokemon name}" where instead of `{pokemon name}` you need write the name of the pokemon, if the pokemon is found, a json string with `name` and `description` will be shown in the browser.
In case you want to use the "Docker" profile, make sure you have "Docker Desktop" installed, from the [docker website](https://www.docker.com/products/docker-desktop).