A vue web app to browse a pokedex
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
This app as been built as part of my study at M2I to practice vue.js and api manipulation
The goal was to create a web app using Vue.js and pinia to fetch data from an API and display a list of pokemons and their details
The app is available Here
- 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.
Data from Tyradex API
This app requires Node.js to be installed
# Clone the project:
git clone https://github.com/Gabann/apidex.git
cd .\APIDEX
# Install the dependencies:
npm i
# Running the application:
npm run dev
# Running the application:
npm run dev
# Building the app:
npm run build
The app gets optimized and minimized to the 'dist' folder and is now ready to be published
As a static web app the app can be deployed to github pages You can automatically build and deploy the app to the 'gh-pages' branch of the repo
# Building the app and automatically push it to gh-pages branch:
npm run deploy
- Rework UI, make something more modern and eye pleasing like this
- Add a way to update the local storage if the API data changes
We welcome contributions from everyone! Follow these steps to contribute:
- Fork the repository.
- Clone the forked repository to your local machine.
- Create a new branch for your contribution.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Open a pull request to the main project repository.
- 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.
Distributed under the 'LICENSE' License. See LICENSE
for more information.