Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
Aryan741x authored Jun 1, 2024
1 parent 40e89ae commit 765fd0e
Showing 1 changed file with 85 additions and 0 deletions.
85 changes: 85 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# SHINY POKEDEX
The Shiny Pokedex is a web application that provides information about shiny versions of Pokemon, including their type and description.
Each Pokemon entry includes details such as its name, type, and a brief description. Users can also view a high-resolution image of the shiny Pokemon to get a better visual representation.

With the Shiny Pokedex, users can easily access information about shiny Pokemon and enhance their knowledge and understanding of these rare and unique variations. Whether you're a seasoned Pokemon trainer or just starting your shiny Pokemon collection, this application is a valuable tool for all Pokemon enthusiasts.

Start exploring the world of shiny Pokemon with the Shiny Pokedex today!

## Introduction

As a passionate Pokemon enthusiast, I have always been fascinated by the world of shiny Pokemon. Their unique colors and rare appearances make them highly sought after by trainers. That's why I created the Shiny Pokedex web application. I wanted to provide a platform where fellow Pokemon lovers can easily access information about shiny Pokemon and enhance their knowledge and understanding of these rare variations.

## Technologies Used

- **HTML**: For structuring the web pages.
- **CSS**: For styling the website.
- **JavaScript**: For interactive elements and the guided tour using Shepherd.js and accessing the the data through pokeapi.
- **Shepherd.js (included via CDN)**: For creating the guided tour.

## Features
- **Home Page**: A single-page application that displays shiny versions of Pokemon.
- **Picture**: High-resolution images of shiny Pokemon are shown to the user.
- **Description**: Detailed information about each Pokemon, including its name, type, and a brief description.
- **Region Selector**: Users can select a specific region (e.g., Kanto, Hoenn) to view Pokemon from that region.
- **Guided Tour**: An interactive tour that guides visitors through the features of the application.

## Acknowledgements
I would like to thank the following resources for their contributions to this project:
- [PokeAPI](https://pokeapi.co/): The API used to fetch Pokemon data.
- [Shepherd.js](https://shepherdjs.dev/): The library used for creating the guided tour.
- [GitHub Pages](https://pages.github.com/): The platform used to host the project.

## Project Structure
.

├── index.html # Home page

├── style.css # Central CSS file for styling

├── main.js # JavaScript for Shepherd.js tour and fetching data from Pokeapi

└── README.md # This file

## Installation

To run this portfolio locally, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/Aryan741x/Shinydex
```
2. Navigate to the project directory:
```bash
cd Shinydex
```
3. Run in Local Server:
```Server
run at server 8000
```
4. Open a browser of your choice and enter in search box:
```bash
http://localhost:8000/
```

## Demo

Watch The Pokemon.mkv file present inside the Repo.

## GH page link

https://aryan741x.github.io/Shinydex/

---

## Future Enhancements
Here are some ideas for future enhancements to the Shiny Pokedex:
- Implement a search functionality to allow users to search for specific Pokemon.
- Add a favorites feature, allowing users to save their favorite shiny Pokemon.
- Include additional information about each Pokemon, such as its abilities and evolution chain.
- Improve the user interface and overall design of the application.

## Contributions
Contributions to this project are welcome! If you have any ideas or suggestions, feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/Aryan741x/Shinydex).

Thanks for your interest in the Shiny Pokedex!

0 comments on commit 765fd0e

Please sign in to comment.