Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinVanDerSchans committed Apr 10, 2024
1 parent 8778b80 commit 4294cc7
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 1 deletion.
129 changes: 128 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,130 @@
# Project Title
# Shopping ReactCart

## ReactJS

<br>

<div align="center">
<img
src="public/readme/project-overview.png"
alt="Project overview"
width="850"
>
</div>
<br>

<div>

Basic shopping cart using useContext and useReducer.

</div>

<br>

**DEPLOY**:
<br>
https://ks-shopping-cart-react.vercel.app

<br>
<br>

# Index

- [Shopping ReactCart](#shopping-reactcart)
- [ReactJS](#reactjs)
- [Index](#index)
- [Features](#features)
- [Technologies and Tools used](#technologies-and-tools-used)
- [Project Setup](#project-setup)
- [Compile and Hot-Reload for Development](#compile-and-hot-reload-for-development)
- [Compile and Minify for Production](#compile-and-minify-for-production)
- [Lint with ESLint](#lint-with-eslint)
- [Contribution](#contribution)
- [Project Status](#project-status)
- [Project Developer](#project-developer)

<br>

## Features

<div>

✔️ Filter by price (0€ - 1000€)

✔️ Filter by category (All, Laptops and Smartphones)

✔️ Add product to cart

✔️ Remove product

✔️ Add more quantities to cart

✔️ Clear shopping cart.

</div>

<br>

## Technologies and Tools used

<div align="center">
<br>
<a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="React" width="60" height="60" style="margin-right: 24px"/></a>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg" alt="JavaScript" width="60" height="60" style="margin-right: 24px" /></a>
</div>

<br>

## Project Setup

```sh
npm install
```

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Compile and Minify for Production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint
```

<br>

## Contribution

If you want to contribute to this project, follow these steps:

1. Perform a fork to the repository.

2. Create a branch for your feature or bugfix: `git checkout -b feature/your-feature-name`

3. Make the necessary changes and commits: `git commit -m 'Add some feature'`

4. Push to branch: `git push origin feature/your-feature-name`

5. Send a pull request to the original repository.

<br>

## Project Status

![COMPLETED](https://img.shields.io/badge/COMPLETED-green.svg)

<br>

## Project Developer

| [<img src="https://avatars.githubusercontent.com/u/122877560?v=4" width=115><br><sub>Kevin Schans</sub>](https://github.com/KevinVanDerSchans) |
| :--------------------------------------------------------------------------------------------------------------------------------------------: |
Binary file added public/readme/project-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4294cc7

Please sign in to comment.