Skip to content
/ ECF-2 Public

An android app that let explore a pokedex and track all your captured pokemons

License

Notifications You must be signed in to change notification settings

Gabann/ECF-2

Repository files navigation

Contributors Forks Stargazers Issues MIT License

ECF 2

An android app that let you explore a pokedex and track all your captured pokemons
Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Preview
  5. Roadmap
  6. Contributing
  7. License
  8. Contact

About the Project

This app as been built in 2 days as part of an exam for my study at M2I.

The goal was to create a mobile app using React Native that consume an API to display a list of pokemons and let the user manage a collection of captured pokemons.

Features

  • Browse Pokemon: Explore detailed information about all Pokemon species, including their types, stats, evolution line and more.
  • Search Functionality: Easily search for specific Pokémon by name, Pokédex number or by their types. For performance the data is store locally and the search is done on the local data.
  • Manage collection: Save your captured pokemons for keep track of your progress to catch them all.
  • Offline Mode: You only need to run the app once with internet connection, and then you can browse the pokedex and manage your collection offline.

Built With

Tech stack:

React React native React Navigation Redux Node.js Typescript Android Studio ESLint SonarLint

Data from Tyradex API

Getting Started

Prerequisites

This project requires:

Full installation guide can be found here

Installation

# Clone the project:
git clone https://github.com/Gabann/ECF-2.git
cd .\ECF-2

# Install the dependencies:
npm i

# Running the application:
npm run android

Usage

Connect your android device or emulator and run the app with npm run android

Preview

App Screenshot App Screenshot App Screenshot App Screenshot App Screenshot App Screenshot

Roadmap

  • Convert components inlay style to stylesheet style
  • IOS port
  • Light & Dark mode
  • Polish style to flat, modern design
  • Options to order pokemons by name, type, etc
  • Add a way to update the data if the api is updated

Contributing

We welcome contributions from everyone! Follow these steps to contribute:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them.
  5. Push your changes to your forked repository.
  6. Open a pull request to the main project repository.

Contribution Guidelines

  • Discuss significant changes by opening an issue first.
  • Follow the existing code style and structure.
  • Write clear commit messages and document your code.
  • Ensure changes don't break existing functionality.
  • Update documentation if necessary.

License

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

Contact

  • Twitter
  • LinkedIn
  • Twitter