Awesome Open Source
Awesome Open Source

Vue Pokédex Maintainability Test Coverage contributions welcome

A Pokédex made for fun in Vue.js.

View live at: https://shadforth.github.io/vue-pokedex

The Pokédex includes the first 251 Pokémon, with:

  • Descriptions and types
  • Base statistics
  • Special attacks
  • Evolutionary forms
  • Audio samples
Vue Pokédex

Getting Started

Prerequisites

  • Node.js & npm

To download Node.js and npm, visit the Node.js downloads page and select the version labelled LTS.

After installing Node.js, run the following command to verify that everything has been installed correctly.

npm -v && node -v

Running the application

# Download project dependencies
npm install

# Run the application on localhost:8080
npm run serve

Key files and folders

  .
  ├── docs/              # Compiled application for GitHub Pages
  ├── public/            # Static assets
  ├── src/               # Main Vue application files
  |   ├── assets/        # Audio, sprites, global CSS
  |   |   └── ...
  |   ├── components/    # Vue components
  |   ├── json/
  |   |   └── data.json  # Scraped Pokédex data
  |   ├── App.vue
  |   ├── event-bus.js   # Connector to pass data b/n children
  |   └── tests/         # Unit tests
  ├── README.md
  └── package.json       # Requirements for npm installation

To do

  • [x] Deploy to GitHub Pages
  • [x] Set up unit tests
  • [ ] Set up e2e tests
  • [ ] Add the remaining 551 Pokémon
  • [ ] Add strengths and weaknesses
  • [ ] Add evolutionary requirements (i.e. Moon Stone, etc.)

Contributions

All contributions welcome. 😃

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,997
vue (4,391
vuejs (1,139
js (555
vue-components (197
vue-cli (169
web-application (117
pokemon (88
nintendo (70