https://github.com/indiecodermm/js-capstone
In this website, users can view popular game characters, and interact with other users by liking and commenting on individual characters. Powered by Amiibo API and Involvement API.
https://github.com/indiecodermm/js-capstone
amiibo-api capstone-project html-css-javascript microverse rest-api webpack
Last synced: 10 months ago
JSON representation
In this website, users can view popular game characters, and interact with other users by liking and commenting on individual characters. Powered by Amiibo API and Involvement API.
- Host: GitHub
- URL: https://github.com/indiecodermm/js-capstone
- Owner: IndieCoderMM
- License: mit
- Created: 2023-01-02T12:29:43.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-11T12:30:26.000Z (about 3 years ago)
- Last Synced: 2025-03-26T22:36:37.010Z (11 months ago)
- Topics: amiibo-api, capstone-project, html-css-javascript, microverse, rest-api, webpack
- Language: JavaScript
- Homepage: https://indiecodermm.github.io/js-capstone/
- Size: 1.63 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [💻 PixelBros ](#-pixelbros-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🎯 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
> 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.
- HTML, CSS, JavaScript
- [Amiibo API](https://www.amiiboapi.com/): API for characters data
- [Involvement API](https://www.notion.so/Involvement-API-869e60b5ad104603aa6db59e08150270): API for user likes and comments
- Webpack: Module bundler
- Jest: Unit testing
- GitHub Project: KanBan Board for tracking the progress
- **Browse through all of the different retro game characters**
- **Like and comment on your favourite characters**
- **View other users' likes and comments**
You can visit the [Live Demo Website](https://indiecodermm.github.io/js-capstone/).
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [Node.js](https://nodejs.org/en/)
### Setup
Clone this repository to your desired folder:
```sh
cd my-project
git clone https://github.com/IndieCoderMM/js-capstone.git .
```
### Install
Install the dependencies with:
```sh
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Run tests
To run tests, run the following command:
```sh
npm run test
```
### Deployment
You can deploy this project using:
```sh
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.
👨🚀 **Hein Thant**
- GitHub: [@IndieCoderMM](https://github.com/IndieCoderMM)
- Twitter: [@hThantO](https://twitter.com/hThantO)
- LinkedIn: [hthantoo](https://www.linkedin.com/in/hthantoo)
👨🚀 **Amanuel Worku**
- GitHub: [@AmanWorku](https://github.com/AmanWorku)
- Twitter: [@Amexworku](https://twitter.com/Amexworku)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/amanuel-worku-844903213/)
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
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](https://github.com/IndieCoderMM/js-capstone/issues).
If you like this project, please consider giving it a ⭐. We really appreciate your support. Thank you!
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.
This project is [MIT](./LICENSE) licensed.