Pokemon API

A simple pokemon catalogue, or Pokédex, built with React, Material-UI and PokéAPI.

View Live

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

I wanted to practice a bit with APIs in a simple react app for an upcoming interview, and I thought "Why not have a bit of fun with it?".

This simple pokemon catalogue, or Pokédex, is made with React, Material-UI and PokéAPI.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/Patchalv/pokemon-api.git

2. Install NPM packages

   npm install

3. Start local development server

   npm start

(back to top)

Roadmap

• Lazy loading images
• Routing so that user can get information about that programme on clicking on one.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Patrick Alvarez Eades - p.alvarezeades@gmail.com

Project Link: https://github.com/Patchalv/pokemon-api

(back to top)

Acknowledgments

A big shout out to Codecademy who I'm currently doing the Full-Stack Engeineer career path with. This project was part of my open-ended project for the Front-end engineer component.

(back to top)