Gotta Fetch 'Em All

A React project for fetching and displaying data!
Explore the repo »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Runnig the app
   • With NPM
   • With Docker
4. Game
5. Roadmap
6. Contributing
7. Contact

About The Project

Welcome to Gotta fetch() 'Em All, an exciting Pokémon encounter game built with React. Leveraging the PokéApi, this project delivers an engaging experience for Pokémon enthusiasts. This project allows users to explore various Pokémon locations, initiate encounters, and engage in battles to capture new Pokémon.

Built With

• 
• 
• 
• 
• 
• 

Getting Started

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

Prerequisites

Before you begin, ensure you have met the following requirements:

• Docker: Required for running in a containerized environment
• npm: Required for running it locally

Installation

1. Clone the repo

   git clone https://github.com/CodecoolGlobal/gotta-fetch-em-all-react-faboknorbert

Running the app

1. Move to the root folder

   cd 3w_gotta-fetch-em-all-react

With NPM

1. Install NPM packages (only have to do it once unless you modify the dependencies)

   npm install

2. Run the application

   npm start

3. You can now access the application at http://localhost:3000

4. To stop the application

   `Ctrl + c`

With Docker

1. Build the Docker image (only have to do it once unless you modify the Dockerfile or removed the container):

   docker build -t pokemon .

2. Start the container:

   docker run -p 3000:80 --name pokemon-container -d pokemon

3. You can now access the application at http://localhost:3000
4. To stop the container:

   docker stop pokemon-container

5. To remove the container (use only if you no longer need it):

   docker rm pokemon-container

Features

• Dynamic Pokémon encounters based on location
• Real-time battle mechanics with win/loss logic
• Responsive UI built with React
• Dockerized for seamless deployment

Game

• Start by entering your username
• Select your starter Pokémon
• And choose a location to visit
• When you encounter a Pokémon, you can fight it or flee from the area
• If you battle it and win you can use it on the next encounter
• If you had it already, no duplication will happen
• If you loose, the enemy will flee
• Currently, the game lacks database connectivity, meaning progress cannot be saved yet
• Right now, there's no database connection for the game, so you cannot save your progress

Change a location and an area where you want to travel. If there is a Pokémon there, choose one of yours and try to catch it by winning the fight.

Roadmap

Below is a list of completed and planned features for the project. Checkmarks indicate implemented features:

• Fetch Pokémon data from PokéAPI
• Build UI for location-based Pokémon encounters
• Allow users to catch Pokémon in battles
• Pokédex like display for caught Pokémon
• Connect to a database to save user progress
• Enhance battle mechanics (e.g., implement Pokémon abilities)
• Deploy the app using Docker and make it publicly accessible
• Add story mode
• Add multiplayer mode

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.

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

Contact

Norbert Fabók - GitHub Profile

György Kocsis - GitHub Profile

Máté Pojbics - GitHub Profile

Project Link: https://github.com/CodecoolGlobal/gotta-fetch-em-all-react-faboknorbert

License

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