Pokédex Webapp
A modern and beautiful Pokédex made with React that communicates with PokéAPI
Status: Published (v. 1.0.0)
Table of Contents
About
This webapp was designed and developed to be an intuitive, modern and fun way to search and check your favorite Pokémon info, stats and movesets by gathering and displaying most recent data from PokéAPI. This is a personal project developed by tvc95.
This project was bootstrapped with Create React App.
Webapp
You can access the webapp by clicking here.
Layout
The application layout was made with Figma. It was inspired from the games (most notably Pokémon HG/SS Pokédex color scheme) and made with Material design in mind.
Mobile
Web
How to use
Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/).
Running the web application (Frontend)
# Clone this repository
$ git clone git@github.com:tvc95/pokedex-react.git
# Access the project folder cmd/terminal
$ cd pokedex-react
# Install the dependencies (choose one option)
## installing through NPM
$ npm install
## installing through Yarn (recommended)
$ yarn
# Run the application in development mode
## NPM
$ npm start
## Yarn (recommended)
$ yarn start
# The application will start at port 3000 - go to http://localhost:3000
🛠 Technologies
The following tools were used the construction of this project:
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
You can contribute as well with the PokéAPI project by updating the API with data from the most recent games. By doing that, you're helping this webapp to be up-to-date!
How to contribute
- Fork the project.
- Create a new branch with your changes:
git checkout -b my-feature - Save your changes and create a commit message telling you what you did:
git commit -m" feature: My new feature " - Submit your changes:
git push origin my-feature
If you have any questions check this guide on how to contribute
License
This project was developed by Thiago Viana and is under the MIT license.
Contact me
