JuanDiegoGuerra / Module_2-Capstone

The JavaScript capstone project is about building your own web application based on an external API.

Pokedex - Group Capstone - Module 2

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Pokedex - Module 2 Capstone

Pokedex - Module 2 Capstone is a simple Pokemon list web application using an existing API.

This project is a basic website that allows users see a list of pokemons in cards. Inside the cards the users are allowed to like the pokemon or add in the popup window displayed when clicking the comment button.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Key Features

• Use of APIs
• POST/GET methods with APIs
• Kanban Board
• Jest Testing library

(back to top)

🚀 Live Demo

• Coming Soon!

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need have the following installed:

- A web browser
- A code editor
- A terminal
- Git
- Node.js

Setup

Clone this repository to your desired folder:

https://github.com/JuanDiegoGuerra/Module_2-Capstone.git

Install

Install this project dependencies with:

  cd into the folder and run `npm install`

Usage

To run the project, execute the following command:

git clone https://github.com/JuanDiegoGuerra/Module_2-Capstone.git

Run tests

To run tests, run the following command:

To test JavaScript:

    run `npx eslint .`

To test HTML:

    run `npx hint .`

To test CSS:

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

Deployment

You can deploy this project using:

GH Pages, publish the branch in git Hub pages

(back to top)

👥 Authors

👤 Juan Diego Guerra (JD)

• GitHub: @Juan Diego
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Lincoln Gibson

• Github: lincoln1883
• Twitter: lincolngibson7
• LinkedIn: lincoln-gibson

(back to top)

🔭 Future Features

• Better Navigation
• Render extra information
• Add Contact section

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project... Please give a ⭐ to the repo and follow us.

(back to top)

🙏 Acknowledgments

I would like to thank my coding partner for putting a lot of effort building this project with me!

(back to top)

📝 License

This project is MIT licensed.

(back to top)