An awesome README template!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
I created this project to enhance my existing knowledge in Vue 3 especially in using Composition API and Pinia data store. I used this open API which has tons of pokemon data https://pokeapi.co
I also used Headless-UI library to add dynamic components like dropdown in this project. For browser-based testing I included Cypress library into this project.
The project is build using Vue 3 with Vite as bundler. This uses Tailwind CSS for UI and Cypress for testing. Data is coming from PokeAPI.
This section would show the screenshots for this project. There are currently 3 images for this project inside the screenshots folder. The screenshots show the Move list page, Pokemon detail page and Move detail page.
This is a Vue 3 project powered by Vite. You need to have Node and npm/yarn installed on your system in order to run this project.
Node and NPM. Some knowledge of Javascript and Vue JS would greatly help.
Simple steps to set this thing on your system.
- Clone the repo
git clone https://github.com/Apfirebolt/vue3_pokedex.git
- Install NPM packages
npm install
- Run the project in development mode on your system
npm run dev
- Create a production build using Vite
npm run build
- Project Prototyping
- Creation of global components and Pages
- Introduction of Pinia for store Management
- Added Cypress for component testing
- Advanced Pagination
- Addition of More pages for contests, areas and more
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
There are a lot of API end-points like contests, areas and much more from the PokeAPI open API. There could well be separate pages for these data from the pokemon games.
Distributed under the MIT License. See LICENSE.md for more information.
Amit Prafulla - @amitprafull - aspper20@gmail.com
Project Link: https://github.com/Apfirebolt/vue3_pokedex
This project owes its existance to following awesome libraries/resources.