View Demo on Render . Design Link · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Problem
   • Solution
   • Built With
   • Database Schema
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • User Stories
     • As a Buyer
     • As a Seller
     • As an Admin
4. Contributing
5. Contact

About The Project

(back to top)

Problem

• Limited access to more buyers
• Lack of experience with some buyers or sellers
• Difficulty in dealing with buyers from outside the region
• Limited search process for cars with certain specifications.

Solution

• Wider access to more buyers
• Manage selling processes
• Tell buyer and seller all details for the sales processes
• There are alot of cars options for buyers
• More reachable to specifice cars

Built With

• React.js
• Express.js
• TypeScript
• PostgreSQL
• Material UI
• Firebase
• Stripe
• Nodemailer

Database Schema

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Create a free account at Firebase
2. Clone the repo

   git clone https://github.com/CA-G12/car-trade.git

3. Install NPM packages

   npm install

4. In the project root folder, rename .env.example file to .env and fill in the environment variables

   SECRET_KEY='<your secret key>'
   DB_URL_DEV=postgres://<username>:<password>@localhost:<port || 5432>/<development database>
   DB_URL_TEST=postgres://<username>:<password>@localhost:<port || 5432>/<test database>
   SECRET_EMAIL='<your email>'
   SECRET_PASSWORD='<your EMAIL password>'
   

(back to top)

Usage

User Stories

As a user who wants to sell a car:

• I can create a new account.
• I can log into my account.
• I want to see my profile.
• I can send request to sell my car.
• I can see my cars and the status of each one.

As a user who wants to buy a car:

• I can create a new account.
• I can log into my account.
• I want to see my profile.
• I want to see all cars that shown to selling.
• I want to filter cars depends on multi-types of spacefications.
• I want to contact admin to more informations.
• I want to reserve the car by paying part of the price.
• I will recive an email message after payment process to complete the purchase procedures.

As a user who wants to control the status of sales requests:

• I can log into admin's dashboard.
• I want to accept/reject any sales request in "pending" state.
• I want to accept/reject any sales request in "on-check" state.
• I want to update the car informations and upload some of it's images befor shown "on-market".

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Our Great Contributors

• Husam abu mughessib - @husam - husamkmal94@gmail.com
• AbdAlilah Abu Al Hussein - @AbdAlilah - abdoumonuir9@gmail.com
• Mai abu aabid - @maimohammed - maiimohammedd21@gmail.com
• Tariq Abu Sada - @tariqesa - tariqesa101@gmail.com

Our Great Team Leader

• Lina Ebeid - @LinaEbeid - linaebe0@gmail.com

Project Link: https://github.com/CA-G12/car-trade

(back to top)