Skip to content

Commit

Permalink
Added README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Zayan-Alaraishy authored Sep 29, 2022
1 parent 1b8084b commit 333e9fd
Showing 1 changed file with 51 additions and 2 deletions.
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
# E-commerce-team5
E-commerce web app using React JS & Node JS
# πŸ›’ Aligrandpa
Aligrandpa is an ecomerce website that allows you to buy tech products.

## πŸš€ Live Link

[Click here to check our great project!](https://ecommerce-team5-geeks.herokuapp.com/)

## πŸ‘€ User journey

* The user will be greated with a landing page that introduces our online shop and will have the option to proceed to the products page with all the projects.
* The user will browse the items at the shop and view each product with its description.
* when the user tries to add an item to his cart while not being logged in, he will get redirected to a log in page to log into his account or sign up a new one.
* the user will be able to change the quantity of the items chosen in his cart and see the total price.

## 😊 User story
* As a user, I will be able to sign into my account or sign up a new account.
* As a user, I will see a cart with all the items I want to buy.
* As a user, I can see an option to log out of my account.
* As a user, I will be able to see all products and search through them
* As a user, I can view the products from one category.
* As a user, I can view all products even when I am not logged in.

## πŸ’‘ Technologies used

- HTML5.
- CSS3.
- JS.
- React JS.
- NPM.
- Node JS
- Express
- Postgresql
## 🌐 API used
- [UI Avatars](https://ui-avatars.com/)

## πŸ’» Installation guide

1. You can click the code drop-down menu above and copy the link to clone the repo or check the coming step!
2. I am going to make it easy for you, here is the link https://github.com/CA-G12/E-commerce-team5.git. In your terminal type the following commands:
* `git clone [link]`.
* `cd E-commerce-team5`
* `npm i` to install the used npm packages in the root.
* `cd client` then `npm i` to install the used npm packages in the client then `npm start` to start your react server.
* `npm start` to start your node js server.
3. Happy coding! ✨

## πŸ±β€πŸ’» Done by
- [Mohammed Alagha](https://github.com/mohammedagha27)
- [Zayan Alaraishy](https://github.com/Zayan-Alaraishy)
- [Assel Abu Sahmoud](https://github.com/AseelL)
- [Mahmoud Hammad](https://github.com/mahmoudhammad309)

0 comments on commit 333e9fd

Please sign in to comment.