Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manununhez authored May 5, 2024
1 parent f8ceff3 commit 530c55b
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,17 @@ PokeTok is a Flutter application that allows you to discover and save your favor

PokeTok provides a fun and engaging way to explore the vast world of Pokémon. With its intuitive user interface inspired by TikTok, you can effortlessly swipe through Pokémon profiles, view their details, and mark your favorites.

## Screenshot
| ![Screenshot 1](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983068-2f76ce49-d9a2-4ffa-b6ef-c7212025b420.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012518Z&X-Amz-Expires=300&X-Amz-Signature=31ae4b6eac7af9f6251ee9fd488f993a75405e4e5e4e7a00c4ec46ea1085bb6a&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 2](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983157-df82681d-4a83-4459-a895-f80fcea04f50.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012747Z&X-Amz-Expires=300&X-Amz-Signature=cdf63fdbb0bab364fe407441ad1582c733548a335503d2815726e1ca5c6cf21d&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 3](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983162-101172fe-1fe6-42a8-956c-731cec44d3f0.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012809Z&X-Amz-Expires=300&X-Amz-Signature=a312d0d4171cc484f3d7cb7256468973693f058305c7a52c87c33d89e3a418c1&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 4](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983166-386d961e-5b47-4eb3-a546-8d993eac0ef4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012832Z&X-Amz-Expires=300&X-Amz-Signature=de305dad1694ac388a0a7de11abf2bfede192d4d3e57ecb369fb29117e8209bc&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) |
|-----------------------------------|-----------------------------------|-----------------------------------|-----------------------------------|
| Pokemon Detail Screen | Favorite Pokemon Detail Screen | Favorites Screen | Empty Favorites Screen |

## Features

- Browse through a collection of Pokémon profiles presented in a TikTok-style feed.
- Save your favorite Pokémon to easily access them later.
- Enjoy a visually appealing and interactive experience while discovering new Pokémon.

## Getting Started

To get started with PokeTok, follow these steps:
- Enjoy a visually appealing and interactive experience while discovering new Pokémon.c

1. Clone the repository to your local machine.
2. Ensure you have Flutter installed on your system.
3. Install the required dependencies by running `flutter pub get`.
4. Run the app on an Android device or emulator.

## Known Issues
## Screenshot
| ![Screenshot 1](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983068-2f76ce49-d9a2-4ffa-b6ef-c7212025b420.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012518Z&X-Amz-Expires=300&X-Amz-Signature=31ae4b6eac7af9f6251ee9fd488f993a75405e4e5e4e7a00c4ec46ea1085bb6a&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 2](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983157-df82681d-4a83-4459-a895-f80fcea04f50.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012747Z&X-Amz-Expires=300&X-Amz-Signature=cdf63fdbb0bab364fe407441ad1582c733548a335503d2815726e1ca5c6cf21d&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 3](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983162-101172fe-1fe6-42a8-956c-731cec44d3f0.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012809Z&X-Amz-Expires=300&X-Amz-Signature=a312d0d4171cc484f3d7cb7256468973693f058305c7a52c87c33d89e3a418c1&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) | ![Screenshot 4](https://github-production-user-asset-6210df.s3.amazonaws.com/5048531/327983166-386d961e-5b47-4eb3-a546-8d993eac0ef4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240505T012832Z&X-Amz-Expires=300&X-Amz-Signature=de305dad1694ac388a0a7de11abf2bfede192d4d3e57ecb369fb29117e8209bc&X-Amz-SignedHeaders=host&actor_id=5048531&key_id=0&repo_id=794278877) |
|-----------------------------------|-----------------------------------|-----------------------------------|-----------------------------------|
| Pokemon Detail Screen | Favorite Pokemon Detail Screen | Favorites Screen | Empty Favorites Screen |

- Currently, PokeTok has only been tested on Android devices due to limitations in device availability. Testing on iOS devices is planned for future releases.

## Roadmap

Expand All @@ -38,6 +26,10 @@ PokeTok is an evolving project with several areas for improvement:
2. **State Management Refactoring**: Consider migrating from the current ChangeNotifier-based state management system to Bloc or Riverpod for better scalability and maintainability.
3. **Increased Test Coverage**: Enhance test coverage to ensure the reliability and stability of the application.

## Known Issues

- Currently, PokeTok has only been tested on Android devices due to limitations in device availability. Testing on iOS devices is planned for future releases.

## Dependencies

PokeTok relies on the following dependencies:
Expand All @@ -48,6 +40,15 @@ PokeTok relies on the following dependencies:
- `provider` for state management.
- `google_fonts` for incorporating custom fonts into the app.

## Getting Started

To get started with PokeTok, follow these steps:

1. Clone the repository to your local machine.
2. Ensure you have Flutter installed on your system.
3. Install the required dependencies by running `flutter pub get`.
4. Run the app on an Android device or emulator.

## Contributions

Contributions to PokeTok are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request on GitHub.
Expand Down

0 comments on commit 530c55b

Please sign in to comment.