https://github.com/gjuliao/pokedex

Simple API that fetches pokemon and filters from categories.
https://github.com/gjuliao/pokedex

Last synced: 6 days ago
JSON representation

Simple API that fetches pokemon and filters from categories.

• Host: GitHub
• URL: https://github.com/gjuliao/pokedex
• Owner: gjuliao
• Created: 2023-01-16T23:48:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T23:53:48.000Z (about 2 years ago)
• Last Synced: 2024-11-17T18:27:08.995Z (2 months ago)
• Language: JavaScript
• Size: 727 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  


  
Microverse




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 Leaderboard App 

**Pokedex** Is a website app that fetches information about the [Pokemon API](https://pokeapi.co/). It's built in pure Javascript and webpack.

## 🛠 Built With 

### Tech Stack 

> 

  Client

  


    
JavaScript

    
HTML

    
CSS

  


### Key Features 

- **Dynamic content using JavaScript**

(back to top)


## 🚀 Zoom Video & Live Demo 

- [Zoom Video](https://drive.google.com/file/d/1fs45-OtzGWLMhOsZhKPy7a0aCFy1Gnin/view?usp=share_link)

- [Live Demo Pokedex App](https://oscar-espinoza.github.io/pokedex/dist)

(back to top)


## 💻 Getting Started 

To get the content of this project locally you need to run the following commands in your terminal:

and follow these steps.

### Prerequisites

- IDE(code editor) like: **Vscode**, **Sublime**, etc.

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)

### Setup

Clone this repository to your desired folder:

1. Download the **Zip** file or clone the repo with:

   `bash git clone [email protected]:oscar-espinoza/pokedex.git`

2. To access cloned directory run:

   `bash cd pokedex `

3. Open it with the live server

### Install

> To install linters and other project's dependencies run:

> `bash npm install `

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:

Test for Linters For tracking linter errors locally you need to follow these steps:

1. For tracking linter errors in HTML files run:

   `bash npx hint . `

2. For tracking linter errors in CSS or SASS files run:

   `bash npx stylelint "**/*.{css,scss}" `

3. For tracking linter errors in javascript files run:

   `bash npx eslint . `

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

👤 **Oscar Espinoza**

👤 **Giovanni Juliao**

- GitHub: [@gjuliao](https://github.com/gjuliao)

- GitHub: [@Oscar-Espinoza](https://github.com/Oscar-Espinoza/)

(back to top)


## 🔭 Future Features 

- [ ] **[Add navigation bar]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page]([../../issues/](https://github.com/Oscar-Espinoza/pokedex/issues)).

(back to top)


## ⭐️ Show your support 

> Write a message to encourage readers to support your project

If you like this project please give us a star!

(back to top)


## 🙏 Acknowledgments 

> Give credit to everyone who inspired your codebase.

I would like to thank Microverse for making the introduction.

(back to top)


## ❓ FAQ 

- **[Question_1]**

  - [Answer_1]

- **[Question_2]**

  - [Answer_2]

(back to top)


## 📝 License 

This project is [MIT](./MIT.md) licensed.

(back to top)