Pokepedia: JavaScript-Group Capstone

📗 Table of Contents

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

📖 Pokepedia: JavaScript Group Capstone

Pokepedia is a simple web application that allows users to view and learn about different Pokemon characters. Users can view images of each Pokemon, add comments to their profiles, and see comments that others have left.

This project is built using JavaScript, HTML, and CSS, with webpack as the build tool. It makes use of the PokeAPI to retrieve information about each Pokemon, and also utilizes a custom API to store and retrieve comments.

🛠 Built With

Tech Stack

• JavaScript
• HTML
• CSS

Client

• JavaScript
• HTML
• CSS

Server

• Express.js

Key Features

• Displaying a list of Pokemon cards with their images, names, and a heart icon for users to like.

• Enabling users to add comments to each Pokemon card by clicking on the "Add Comment" button.

• Displaying a pop-up window when a user clicks on the "Add Comment" button, which includes the Pokemon's details and a form to add a comment.

• Fetching and displaying previous comments for each Pokemon from an API.

• Allowing users to add comments for each Pokemon to the API by submitting a form.

• Displaying the number of previous comments for each Pokemon.

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project, you need to have a web browser installed on your computer.

Setup

Clone this repository to your desired folder by running the following command:

  [email protected]:MussieTeka/JavaScript-Group-Capstone.git

Install

Run npm install to install all dependencies

  cd JavaScript-Group-Capstone
  npm install

Usage

Run npm start to start the application using webapp live server.

  npm start

Run tests

To run tests for this project, follow these steps:

• Open the command prompt or terminal on your computer.
• Navigate to the project directory using the cd command.
• Type the command npm run test and press enter.

 npm run test

Deployment

You can deploy this project using any web hosting service of your choice.

(back to top)

👥 Authors

This project was developed by:

👤 Mussie Kahsay - Developer

• GitHub: @MussieTeka
• Twitter: @mussieteka
• LinkedIn: @mussieteka

👤 Author2

• GitHub: @ikennarichard
• LinkedIn: Ikenna Oguejiofor

(back to top)

🔭 Future Features

• User Profiles: Allow users to create profiles on the website, including a profile picture, bio, and other details. This could also include the ability for users to follow each other or connect in some way.

• Social Media Integration: Allow users to easily share content from the website on popular social media platforms, such as Facebook, Twitter, Instagram, and LinkedIn.

• User Reviews: Allow users to leave reviews or ratings for products, services, or other content on the website. This could help build trust and credibility with potential customers.

(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 it a star on GitHub.

(back to top)

🙏 Acknowledgments

This project was inspired by the PokeAPI, an open API for accessing Pokémon data.

The following resources were used in the development of this project:

• Font Awesome
• Webpack
• Microverse

(back to top)

❓ FAQ (OPTIONAL)

• Can I modify and redistribute this project?

  • Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.

• How can I contribute to this project?

  • Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)