Ultradex

A Pokédex app built using Vue, Bulma and data from the pokéapi and Bulbapedia.

Features

The app shows you a list of all Pokémon, and let's you view more information on each one, including stats of different forms of the Pokémon, the Pokémon's types, the in-game Pokédex description, and the Pokémon's sprites.

In addition, you can read the relevant wiki entry from Bulbapedia, which gives additional insights about the Pokémon's biology and appearances in the Pokémon anime and manga, as well as some trivia.

Project setup

npm install

Development

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Cypress

npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing

Lint with ESLint

npm run lint

Parses Bulbapedia export and creates JSON files in /public

Runs automatically after npm install.

npm run bulbapedia

Notes

Font Awesome Pro

This project uses the Pro version of Font Awesome 5. To build the project as-is, you will need your own license key, and follow the npm/yarn setup instructions on fontawesome.com.

If you do not have a Pro license you can alter the project to use the free version. In that case, install @fortawesome/free-solid-svg-icons as a dependency instead of the equivalent pro package, and change the import in src/main.js.

Please note that the Pro version, in addition to alternate styles, includes more icons than the free version. If pro icons exists in the project, those will likely also need to be changed.

Data exported from Bulbapedia

The wiki entry feature uses data exported from Bulbapedia. The raw export file can be found in bulbapedia-data/bulbapedia-pokemon-export.xml. The exported file is transformed using a script, and saves one exported JSON file in public/data for each Pokémon, labeled by the Pokémon's national Pokédex ID. Like Bulbapedia itself, both the raw export file and the processed data files are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 2.5 license.

Disclaimer

This project is not in any way affiliated with or endorsed by Nintendo/Creatures Inc./GAME FREAK inc./The Pokémon Company.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License from the attached LICENSE file or at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

16patsle / ultradex Goto Github PK

ultradex's Introduction