An open API service indexing awesome lists of open source software.

https://github.com/krisbobo/shop-app

The shop app allows a user to shop for items. One page has the list of items which can be filtered based on its category and a page which holds specific details for chosen items. Built with React!
https://github.com/krisbobo/shop-app

javascript javascript-applications javascript-framework javascript-library react

Last synced: 9 months ago
JSON representation

The shop app allows a user to shop for items. One page has the list of items which can be filtered based on its category and a page which holds specific details for chosen items. Built with React!

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Shop App\] ](#-shop-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo and other links ](#-live-demo-and-other-links-)
- [💻 Getting Started ](#-getting-started-)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [Shop App]

> The shop app is a mobile web app that allows a user to shop for items online. The API selected allows for users to select specific categories to enable them shop items faster. The web page has several pages and it follows responsive design. The pages are as follows:
- One page has the list of items which can be filtered based on its category
- Another page holds specific details for items chosen.

## 🛠 Built With

The major tools and languages used are:

- REACT
- JavaScript

### Tech Stack

> The following tech stack were used

REACT

### Key Features

> The web app has the following key features:

- **[Allows you to filter categories]**
- **[Display selected item on another page]**

[Back to Top]

## 🚀 Live Demo and other links

> Here is a live demo link

- [Shop app](https://shop-app-beryl.vercel.app/)
- [Video Link](https://www.loom.com/share/c77bb7979cba492b998364be756620f4)

[Back to Top]

## 💻 Getting Started

> In order to run this project you need:

- Node js installed on your computer
- Npm Node package manager
- Terminal

### Setup

Clone this repository to your desired folder:

> git@github.com:krisbobo/shop-app.git

### Install

Install this project with:

```sh
cd my-project
npm install or npm i
```
-

### Usage

To run the project, execute the following command:

```sh
npm run build
```

### Run tests

To run tests, run the following command:

```sh
npm test or jest test
```

[Back to Top]

## 👥 Authors

👤 **Christian Kiyong**

- GitHub: [krisbobo](https://github.com/krisbobo)
- Twitter: [ChrisboboSys](https://twitter.com/ChrisboboSys)
- LinkedIn: [kiyong-christian](https://linkedin.com/in/christian-kiyong)

[Back to Top]

## 🔭 Future Features

> The following two features will be added to this project;

- [ ] **[Additional pages such as about me etc]**
- [ ] **[UX improvements]**

[Back to Top]

## 🤝 Contributing

Contributions, issues, and feature requests are welcome.

Feel free to check the [issues page](../../issues/).

[Back to Top]

## ⭐️ Show your support

If you like this project, don't forget give a ⭐️ or buy me a coffee ☕️

[Back to Top]

## 🙏 Acknowledgments

- Microverse student community.
- Nelson Sakwa on Behance
- Anyone whose code was used

[Back to Top]

## 📝 License

This project is [MIT](./LICENSE) licensed.

[Back to Top]