Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.89 KB

README.md

File metadata and controls

95 lines (68 loc) · 3.89 KB
Raw

README :

Bastta.com is a website that allows users to publish or buy second-hand products from all categories. The website helps products' owners to find their best customers and contact directly with them.

The Problem 🚫 :-

There is a big amount of products that are offered for sale but it is hard for the owner to find the best buyer for his product and there are a lot of people that find it hard to look for a specific used product to buy and contact with the seller.

The solution 💡 :-

We founded this website to make easy contact between second-hand products' buyers and sellers. The website facilitates the way of publishing and buying used products for all users. For society terms validation, there are admins to accept or deny published products.

User Stories 📚

User who wants to buy or sell a product 📖

As a user, I can :

  • Browse all available products on the website.
  • Filter published products by their category.
  • Filter products by their location or price.
  • Search about a product by its name.
  • Create an account to buy or sell products.
  • Publish my products to find a buyer.
  • Buy products by contacting the product's owner.
  • Delete and edit my products.
  • Add products to my favourites.
  • See favourite products on the profile page.
  • See more details about the product.
  • See information about the website on the about us page

User who is an admin 🔢

As an admin, I can :

  • Access admin page and see all products filtered in the dashboard.
  • See all users on the website.
  • Accept or deny newly published products.
  • Delete products or users

User Journey ✏️

User who want to buy a product 📖

  • The user will see all categories of the products in the categories nav and filter presented products by their category.
  • The user can choose his suitable filter from the sidebar by location or price
  • By clicking on the product's card you will move to its page for more information.
  • User's products are listed on the profile page with a button for delete and an icon to edit the product.
  • There is a button in the product's card which allows the user to start chatting with the product's owner.

User who is an admin 🔢

  • There is a table that presents all users and products. The admin can delete a product or a user when he presses the delete button and confirms his action

How to Launch App Locally :-

  • clone this repo by typing this command in the terminal:
    https://github.com/GSG-G10/bastta.git

  • Enter the folder cd bastaa

  • Run npm i to install the packages for the app in general.

  • Run cd client and npm i to install the packages for the client- ReactJs.

Database Setup 📋

Environment variables:

Environment variables are one of the ways we keep our products safe. If you want to access our app locally you will need to add your own.

  • create .env file
  • add your Environment variables
DATABASE_URL= # Your production connect

Start the App 🔌

To start the App Locally you can start the server First then start client-side or vice versa!

To run Server, In your terminal Type:

`npm run dev` then you should be able to go to (http://localhost:5000/)

To run client-side, In your terminal Type:

`cd client` => `npm start` then you will be able to run (http://localhost:3000/)

Now you can view the app live in the Browser!

Technologies 💻 :-

  • BackEnd: Express-Node JS,
  • FrontEnd: React.js
  • Database: Postgresql
  • Libraries: MUI

Team Members :-