Code Monkey home page Code Monkey logo

pokedex-vue-tailwindcss's Introduction

GitHub license Netlify Status

A simple online Pokédex using PokéAPI.

View Demo


Table of Contents
  1. Getting Started
  2. Style Guide
  3. Features
  4. Folder Structure
  5. Improvments / Features to add
  6. License
  7. Authors and Contact
  8. Acknowledgments

Getting Started

Built With

(back to top)

Prerequisites

Install the latest version of npm, on the command line, run the following command:

> npm install -g npm

Once you have npm installed you can run the following both to install and upgrade Yarn:

> npm install --global yarn

(back to top)

Installation

Follow the steps below to get started with this project's development environment.

  1. Clone this repository and navigate into it.
> git clone https://github.com/VichithLy/pokedex-vue-tailwindcss
> cd pokedex-vue-tailwindcss/
  1. Install the project's dependencies.
> yarn install
  1. Start the development environment.
> yarn serve
  1. You should see the following after yarn serve
  App running at:
  - Local:   http://localhost:8080/
  - Network: http://xxx.xxx.x.x:8080/

Open the link in your browser. You're now ready to develop!

If you want to compile and minify the project for production, use

> yarn build

To lint and fix files, use

> yarn lint

(back to top)

Style Guide

(back to top)

Features

  • Get all Pokémon from the API
  • Search Pokémon by Name or ID
  • Sort Pokémon by
    • Region (only 1)
    • Type (maximum 2)
    • Name (ascending and descending)
    • ID (ascending and descending)
  • Get some basic information about a Pokémon
    • Name
    • Number (or ID)
    • Types
    • Base stats
    • Small description
    • Measurements (height and weight)
    • Evolution chain
    • Main abilities
  • Reset form
  • Search bar with autocomplete search suggestions
  • Display simple and detailed cards of Pokémon
  • Infinite scroll (Load more Pokémon)
  • Loading skeletons (on first landing Home page and when a Pokémon is loading)

(back to top)

Folder Structure

.
├── ...
├── src
│ ├── assets # Images, icons and style files
│ ├── components # Vue Components
│ ├── composables # Composable functions (for Vue Composition API)
│ ├── constants # Mostly enumerations (types, regions, etc.)
│ ├── data # Static JSON data (regions, types, Pokémon)
│ ├── router # Vue router configuration
│ ├── services # PokéAPI requests
│ ├── store # Vuex configuration
│ ├── utils # Useful functions
│ └── views # Main pages of the app
└── ...

(back to top)

Improvments / Features to add

  • More details on Pokémon
  • Dark Mode
  • Progressive Web App
  • Offline mode
  • Multilingual app

(back to top)

License

MIT License

Copyright (c) 2022 Julien MILLOT and Vichith LY

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

(back to top)

Authors and Contact

Julien MILLOT - https://github.com/Jilvo
Vichith LY - [email protected] - https://github.com/VichithLy
Project link: https://github.com/VichithLy/pokedex-vue-tailwindcss

(back to top)

Acknowledgments

(back to top)

pokedex-vue-tailwindcss's People

Contributors

vichithly avatar jilvo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.