📗 Table of Contents

• 📗 Table of Contents
• 💻 PixelBros
  • 🛠 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

💻 PixelBros

This is a capstone project we built at the end of JavaScript Module during our study in Microverse program.

PixelBros is a website where users can view high-quality images of popular retro game characters. Users can also like and comment on their favourite ones and see which characters are the most popular.

The website uses Amiibo API to get information about all popular Nintendo characters from popular franchises such as Super Smash Bros, the Legend of Zelda, and Mario. Whether you're a fan of Mario, Pokemon or any other beloved characters, you'll be able to find them on this website.

   

🛠 Built With

Tech Stack

• HTML, CSS, JavaScript
• Amiibo API: API for characters data
• Involvement API: API for user likes and comments
• Webpack: Module bundler
• Jest: Unit testing
• GitHub Project: KanBan Board for tracking the progress

Key Features

• Browse through all of the different retro game characters
• Like and comment on your favourite characters
• View other users' likes and comments

(back to top)

🚀 Live Demo

You can visit the Live Demo Website.

(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:

• Node.js

Setup

Clone this repository to your desired folder:

  cd my-project
  git clone https://github.com/IndieCoderMM/js-capstone.git .

Install

Install the dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using:

  npm run build

This will create a production ready build for website in the dist directory. You can then deploy this directory on the GitHub Pages.

👥 Authors

👨‍🚀 Hein Thant

• GitHub: @IndieCoderMM
• Twitter: @hThantO
• LinkedIn: hthantoo

👨‍🚀 Amanuel Worku

• GitHub: @AmanWorku
• Twitter: @Amexworku
• LinkedIn: LinkedIn

(back to top)

🎯 Future Features

These are the features we want to implement in the upcoming updates.

• Add a hero section
• Implement search feature
• Add reservations
• Add sort-by button

(back to top)

🤝 Contributing

We welcome any contributions to our website! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

Feel free to check the issues page.

(back to top)

💖 Show your support

If you like this project, please consider giving it a ⭐. We really appreciate your support. Thank you!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving us this opportunity to work together and work on a project to understand what we have learned.

(back to top)

📝 License

This project is MIT licensed.

(back to top)