Pokedex

By Tristan Emmerson, James Henager, Taylor Phillips, Allison Sadin and Noel Kirkland

Description

Pokédex is a comprehensive API and web application to list and display all of the original 151 Pokémon. Pokemon can be browsed in order of Pokédex number or by their Pokémon Type. Each Pokémon entry in the API contains details about that Pokémon; including it's stats, image and average physical characteristics.

Project goals

For this project we had the following goals for our minimum viable product:

• A Pokemon class, a PokeType class, and a User class
• Full crud functionality
• Seeded data for all 151 Pokemon
• Seeded data for all 13 Pokemon types
• Fully functional API
• Full user interface

Some of our stretch goals were:

• A MyTeam feature that would allow the user to add specific Pokemon to their own collection
• Identity authentication
• Search bar functionality
• Pokemon silhouette guessing game
• Publish project online

User Stories

• As a Pokemon Master, I need to be able to navigate to the Pokedex home index page.

• As a Pokemon Master, I need to be able to navigate to a Pokemon index page, so that I can see all recorded Pokemon.

• As a Pokemon Master, I need to be able to click on a specific Pokemon, so that I can see that Pokemon's details, and it's associated type.

• As a Pokemon Master, I need to be able to navigate to a types index page, so that I can see all Pokemon types.

• As a Pokemon Master, I need to be able to click on a specific type, so that I can see that type's details, and it's associated Pokemon.

Setup/Installation Requirements

• Install the .NET framework

  1. This program utilizes .NET version 3.1, and requires this framework to be pre-installed

• Install and configure MySQL

  1. This program utilizes MySQL Community Server version 8.0.15 and requires this to be pre-installed. Click the link at the bottom that reads "No thanks, just start my download"
  2. Use Legacy Password Encryption and set password to "epicodus"
  3. Click "Finish

• Download this application from GitHub

  1. Open the following web address in your browser: /~https://github.com/tmemmerson
  2. Click on the button labeled Repositories
  3. Navigate into the Pokedex.Solution repository and click the green button labeled "Clone or download" and download the zip to your computer

• Install the MySQL database

  1. Open the downloaded application in a text editor (V.S. Code preferred)
  2. Open a new terminal in your text editor (Ctrl+` in V.S. Code) and run command > echo 'export PATH="$PATH:/usr/local/mysql/bin"' >> ~/.zprofile
  3. Enter the command > source ~/.zprofile to confirm MsSQL has been installed

• Run the application

  1. In the terminal, navigate to the API directory by running the command > cd Pokedex
  2. Now that we are in the Pokedex directory you will run the command > dotnet restore
  3. Once you see the Obj folder pop up in the directory you will run the command > dotnet ef database update
  4. Once your terminal has finished loading you will run the command > dotnet run
  5. Now that we have the API running, run the following command to return to the root directory > cd ..
  6. Navigate to the client directory by running the command > cd PokedexClient
  7. Now that we are in the PokedexClient directory you will run another restore> dotnet restore
  8. Lastly, you will need to run the following command > dotnet run

• Use the application

  1. Visit the URL http://localhost:5003 in your preferred browser and have fun!

Known Bugs

No Known bugs as of 8/25/20

Support and Contact Details

For any questions or concerns, please feel free to contact a member of our team:

• James Henager - jameschenager@gmail.com
• Noel Kirkland - noelkirkland@gmail.com
• Allison Sadin - aesadin@gmail.com
• Taylor Phillips - taylorphillips133@gmail.com
• Tristan Emmerson - tristan@stickerslug.com

Technologies Used

• ASP.net Core
• C#

Contributors

|
_{Allison Sadin}

|
_{James Henager}

|
_{Noel Kirkland}

|
_{Taylor Phillips}

|
_{Tristan Emmerson}

License

Copyright (c) 2020 Tristan Emmerson, James Henager, Taylor Phillips, Allison Sadin, and Noel Kirkland