Paulinelali / pokemon

Pokemon - group Microverse project

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Pokemon]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Pokemon]

Pokemon Group project This group project app utilizes the Pokemon API to create an interactive application centered around Pokemon. The app allows users to explore and discover Pokemon names, add comment, and engage in adding likes .. we implement some of the functional we learn through the module : Use ES6 syntax. Use ES6 modules. Use callbacks and promises. Use webpack. Apply JavaScript best practices and language style guides in code. Use AAA pattern for unit tests. Write units tests for a JavaScript app. Follow Gitflow. Solve simple git conflicts. Send and receive data from an API. Use API documentation. Understand and use JSON. Make JavaScript code asynchronous. Perform a code review for a team member. unit tests.

• Write units tests for a JavaScript app.
• Follow Gitflow.
• Solve simple git conflicts.
• Send and receive data from an API.
• Use API documentation.
• Use JSON.
• Make JavaScript code asynchronous.
• Perform a code review for eachother.

🛠 Built With

Tech Stack

Client

• JS
• HTML
• CSS
• Webpack

Key Features

• Shows Pokemons images and names
• Add Comments
• View the comments
• Add likes to your favorite pokemon

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

• Open your Terminal
• Navigate to the desired directory to which you want to clone the repository to
• [Copy & Paste] git clone https://github.com/Mofuhidy/group-capstone-js.git

Prerequisites

In order to run this project you need:

• Basic knowledge of HTML and CSS
• Basic understanding of Linters
• Basic understanding of Github
• Basic understanding of run project by npm
• Your machine should have Chrome or any of your favorite browsers and VSCode installed

Setup

Clone this repository to your desired folder:

• git clone https://github.com/Mofuhidy/group-capstone-js.git

Install

Install this project with:

• You need to install Chrome if you want to see it working locally

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

npx stylelint "\*_/_.{css,scss}"
npx hint .
npx eslint .
npm test

Deployment

You can deploy this on your local dev server

    npm install
    npm start

Once success it will automaticly running, you should see your application working at: http://localhost:8080/ Every change you make in js or css files now should be reflected in a browser a few seconds later.

(back to top)

👥 Authors

👤 MoFuhidy

• GitHub: @Mofuhidy
• LinkedIn: @Mofuhidy

👤 Paulinelali

• GitHub: @Paulinelali
• LinkedIn: @Paulinelali

(back to top)

🔭 Future Features

• Add search form
• Add pagination

(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 give it a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank microverse for this project

(back to top)

📝 License

This project is MIT licensed.

(back to top)