thepra/Pokespearean
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Pokemon description API as if it was told by Shakespeare
11 Commits 1 Branch 0 Tags 48 KiB
C# 92.6%
Dockerfile 7.4%
fc076d5e3a
Go to file
Yevheniy Hvozdikov fc076d5e3a Adding a Note in README 
Adding a note for Visual Studio and GIT
2020-11-23 10:48:56 +01:00
Pokespearean Fix - Cleaning up the input pokemonName 2020-11-22 19:00:06 +01:00
Pokespearean.Models Reorganizing the structure of the project, adding unit testing, adding PokemonService and ShakespeareService. 2020-11-22 18:38:59 +01:00
Pokespearean.Tests Reorganizing the structure of the project, adding unit testing, adding PokemonService and ShakespeareService. 2020-11-22 18:38:59 +01:00
.gitattributes Add .gitignore and .gitattributes. 2020-11-22 10:34:20 +01:00
.gitignore Add .gitignore and .gitattributes. 2020-11-22 10:34:20 +01:00
LICENSE Fix - Moving License and Readme to the right location 2020-11-22 18:41:38 +01:00
Pokespearean.sln Reorganizing the structure of the project, adding unit testing, adding PokemonService and ShakespeareService. 2020-11-22 18:38:59 +01:00
README.md Adding a Note in README 2020-11-23 10:48:56 +01:00

README.md

Pokespearean

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.

Wanted improvements

  • Add documentation, possibly with swagger
  • Adding a validation service layer, so the incoming data can be validated before any other call
  • Adding more test coverage for the services behind the controller

Note

In case of Visual Studio git pull of the project, make sure to have GIT installed(Windows)