Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 3.85 KB

README_en.md

File metadata and controls

107 lines (68 loc) · 3.85 KB

Trybe Logo Pokémon App Trybe Logo

🌐 Português Español English Русский 中文 العربية

Application Preview

Welcome to the Pokémon App, an application developed in React that displays a list of Pokémon, allows viewing specific details, and marking favorites.

📋 Prerequisites

To test and run the application, you need to have the following environment configured:

  • Node.js version 18 or 16 (Node.js 18 is recommended to ensure compatibility with dependencies).

Check the Node.js Version

To check if the installed version of Node.js is compatible, use the command:

node -v

Make sure the output is v18.x.x or v16.x.x. If you need to install or update Node.js, you can download it here.

📦 Installation

Follow the steps below to run the application locally:

  1. Clone the repository:

    git clone git@github.com:SamuelRocha91/pokedex.git
  2. Navigate to the project directory:

    cd pokemon-app
  3. Install dependencies:

    Run the command below to install all necessary dependencies:

    npm install
  4. Run the application:

    After installing the dependencies, start the application with the command:

    npm start

    This will start the development server. Open your browser and go to http://localhost:3000 to view the application.

✨ Features

  • Pokedex: Displays the list of Pokémon with the ability to favorite.
  • Pokémon Details: Shows detailed information about the selected Pokémon.
  • Favorite Pokémon: A dedicated page for Pokémon marked as favorites.
  • About Page: Explains the purpose of the application.
  • Not Found Page (404): Shown when a nonexistent route is accessed.

📂 Project Structure

The application is structured as follows:

  • /src: Contains all the source code of the application.
    • /components: Reusable components.
    • /pages: Application pages (Pokedex, Details, Favorites, About, etc.).
    • /types: Defined PropTypes for prop validation.
    • Routes.js: Defines the main routes of the application.

🧪 Tests

To ensure that the application is working correctly, you can run the automated tests using:

npm test

🔗 Other Projects