Skip to content

Latest commit

 

History

History
85 lines (48 loc) · 3.13 KB

README.md

File metadata and controls

85 lines (48 loc) · 3.13 KB
Raw

Choose Your Pokemon

"Choose your Pokemon" is a Webpack project meant to fetch data from two different APIs: PokéAPI and Involvement API. Here we display a list of 20 Pokemons for whom one can like, display more info, and comment; all based on the data from these two external resources.

Preview)

Got to code them all! The ultimate fan database is now available. Go through the list of Pokemons, pick the best ones (including evolution), comment, like, and see which one is the best among the community of Trainers!

Built With

  • HTML/SCSS, JavaScript.
  • WebPack, Jest, External APIs.
  • Visual Studio Code, Polypane.

Live Demo

Live Demo Link

Getting Started

To get a local copy up and running follow these simple example steps.

  • Clone this repository with git clonegit@github.com:carloshs1994/choose-your-pokemon.git using your terminal or command line.
  • Change to the project directory by entering :
    cd choose-your-pokemon in the terminal

Prerequisites

You need to make sure to have installed the latest version of Node.js and npm on your computer.

Setup

You can clone this repository or simply download the files as a .zip If you want to set up a personal repository based on this one, you can as well fork it.

Install

After clone it and before working on it, you have to run npm install so that all the dependencies of the project get downloaded in your pc locally. Such dependencies include webpack and linters checks, for which you have to either generate your own config file or get one.

Note: If you're a Microverse's Student, you should use the config files provided by the program. Linters Config HTML/CSS and JS

About WebPack deploy to Github Pages

The dependencies and configuration are all set to deploy the dist folder to a gh-pages branch. The only thing you need to do is to change the publicPath inside webpack.config.js to match the one of your project.

Usage

You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below

Run linters checks

Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.

Deployment

The deployment can be found in the Github Pages of this repository or through the link provided above

Authors

👤 Carlos Herver Solano

👤 Andrés Felipe Arroyave Naranjo

Acknowledgments

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.