AUTO MART

Auto Mart is an online marketplace for automobiles of diverse makes, model or body type. With Auto Mart, users can sell their cars or buy from trusted dealerships or private sellers.

UI Templates

My UI templates can be found here: UI

Pivotal Tracker

My Pivotal Tracker board can be found here

API Documentation

My API documentation can be found here

Heroku Link

My Heroku Link can be found here

Key Application Features

1. User can sign up.
2. User can sign in.
3. User (seller) can post a car sale advertisement.
4. User (buyer) can make a purchase order.
5. User (buyer) can update the price of his/her purchase order.
6. User (seller) can mark his/her posted AD as sold.
7. User (seller) can update the price of his/her posted AD.
8. User can view a specific car.
9. User can view all unsold cars.
10. User can view all unsold cars within a price range.
11. Admin can delete a posted AD record.
12. Admin can view all posted ADs whether sold or unsold.

Additional Features

1. User can reset password.
2. User can view all cars of a specific body type.
3. User can flag/report a car sale advertisement.
4. User can view all used unsold cars.
5. User can view all new unsold cars.
6. User can view all unsold cars of a specific make (manufacturer).
7. User can view his Ads history.

Prerequisites

• Node.js must be installed

Installing

• Clone this repository https://github.com/King-Success/Auto-Mart.git

• Run npm install on the root directory to install all the application's dependencies

• Set the following environment variables in your .env file:

  • PORT - A random number on which the application is going to listen on.

  • SECRET - A random string for generating auth tokens.

  • DB_URL - A database URL provided by Elephant.

  • MAIL_HOST - A mail host e.g Gmail - smtp.gmail.com.

  • MAIL_PORT - A mail port e.g Gmail - 465.

  • MAIL_ENCRYPTION - Should be set to true or false

  • MAIL_USERNAME - Your email username

  • MAIL_PASSWORD - Your email password

Testing Locally

• Run npm test

Testing With Postman

• Install Postman.
• View the API documentation here.

Built With

• Node.Js
• ExpressJs

Coding Style

• AirBnB

Testing Tools

• Mocha
• Chai
• nyc
• Istanbul

Acknowledgements

• README Format - Billie Thompson.