Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/juanpa8830/pokeapp

Pokeapp is an aplication that allows users to identify their favourite pokemos from a list that is displayed in the home page. Users are also allowed to give a like to the pokemon they love and reserve one of them for their next tournament! It was implemented with HTML, CSS, JavaScript and Webpack!
https://github.com/juanpa8830/pokeapp

Last synced: 21 days ago
JSON representation

Pokeapp is an aplication that allows users to identify their favourite pokemos from a list that is displayed in the home page. Users are also allowed to give a like to the pokemon they love and reserve one of them for their next tournament! It was implemented with HTML, CSS, JavaScript and Webpack!

Awesome Lists containing this project

README

        

Pokémon Web Application

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [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)

# 📖 Project Name

## Pokémon Web Application

## 🛠 Built With

- HTML, CSS, and JavaScript

### Key Features

> Describe between 1-3 key features of the application.

- Use of Pokémon database to show data about different pokémons and their abilities in a popup.
- Use of API to store comments and reservation for pokémons.
- Project with webpack.
- Used HTML Webpack Plugin to generate HTML files.
- All HTML contents are loaded dynamically.
- Function to count comments and reservations from the document object model.
- Styling used a wireframe template.
- Code is created in src folder and dist folder is generated using webpack.

(back to top)

## 🚀 Live Demo

Have a look the live demo of the website [here](https://juanpa8830.github.io/pokeapp/dist/).

(back to top)

## 💻 Getting Started
To clone the repository in local environment try following steps.

### Prerequisites

- [x] A web browser like Google Chrome.
- [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```

Likewise for Node.js and npm for package installation.
```
$ node --version && npm --version
```
### Setup

Clone the repository using [this link](https://github.com/PrangonGhose/Leaderboard.git)

### Install

In the terminal, go to your file directory and run this command.

```
$ git clone https://github.com/PrangonGhose/Leaderboard.git
```
### Get into development

In the terminal, run these commands to get into development.
```
$ cd pokeapp

$ npm init -y

$ npm install (install dependencies)

$ npm run build (create the optimized for production)

$ npm start (run the app locally)
```
### Usage

This website is applicable for both mobile and desktop version.

### Run tests

### Deployment

(back to top)

## 👥 Authors

👤 **Juan Pablo Guerrero**

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

👤 **Prangon Ghose**

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

👤 **Pedro Henrique Domingues Neves**

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

(back to top)

## 🔭 Future Features

- [ ] **Styling of the webpage**
- [ ] **Animation to add functionality**
- [ ] **Adding responsiveness**
- [ ] **Adding more pages using API**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the [issues page](https://github.com/Juanpa8830/pokeapp/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

Authors would like to thank:
- [Microverse](https://www.microverse.org/)
- [PokéAPI](https://pokeapi.co/)
- Code Reviewers
- Coding Partners

(back to top)

## ❓ FAQ

(back to top)

## 📝 License

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