Skip to content

Gabann/APIDEX

Repository files navigation

Contributors Forks Stargazers Issues MIT License

Apidex

A vue web app to browse a pokedex
Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Preview
  5. Roadmap
  6. Contributing
  7. License
  8. Contacts

About the Project

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

Features

  • 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.

Built With

Vue.js Pinia Bootstrap Node.js

Data from Tyradex API

Getting Started

Prerequisites

This app requires Node.js to be installed

Installation

# Clone the project:
git clone https://github.com/Gabann/apidex.git
cd .\APIDEX

# Install the dependencies:
npm i

# Running the application:
npm run dev

Usage

# Running the application:
npm run dev

Deployment

# 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

Preview

App Screenshot App Screenshot App Screenshot App Screenshot

Roadmap

  • Rework UI, make something more modern and eye pleasing like this
  • Add a way to update the local storage if the API data changes

Contributing

We welcome contributions from everyone! Follow these steps to contribute:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them.
  5. Push your changes to your forked repository.
  6. Open a pull request to the main project repository.

Contribution Guidelines

  • 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.

License

Distributed under the 'LICENSE' License. See LICENSE for more information.

Contacts

  • Twitter
  • LinkedIn
  • Twitter