AUTOMART PROJECT API

A market place for both selling and buying automobiles for solving multiple issues that face dealers and buyers at the market (Our sight is to serve you with the best quality of services).

Documentation

Comprehensive documentation for the API is hosted here.

Deployment

This app his hosted on heroku here

Features

• Users can sign up or register.

• Users can sign in or log in.

• Users can create a car sale ad.

• Users can create a purchase order.

• Users can update the price of a purchase order. only if the order’s status is still pending.

• Users can mark their posted car ad as sold (If they're the owners)

• Users can update the price of their posted car ad (If they're the owners)

• Users can view a specific car

• Users can view all unsold cars

• Users can view all unsold cars within a price range (considering min and max value)

• Users can delete a specific car Ad ( Obviously if they're owners or admins)

• Users can view all posted ads whether sold or available.

• Users can flag or report a posted AD as fraudulent.

• Users can view all unsold cars of a specific make or manufacturer

• Users view all unsold cars of a specific make or manufacturer.

• Users can view all unsold cars of a specific make or manufacturer.

• Users can view all cars of a specific body type.

• Admins can both see any car add and delete it

Tools

Tools used for development of this API are;

• Documentation : Apiary
• Framework: ExpressJS
• Code Editor/IDE: VSCode
• Programming language: JavaScript(ES6)
• API Testing environment: Postman

Getting Started

1. Clone the github repository here,

2. Install all the dependencies by running the following command in your command line interface

    $ npm install

3. Once you're done making sure that everything is up-to-date start the API server by running the following command in your command line interface:

    $ npm start

Asserts or tests

To run the tests and make sure that all api endpoints are working perfectly just type in your command line interface the following commands :

   $ npm test 

if the stated commands are not succesful try to install all the development dependencies to fix it

#Learning resources

• (http://dsernst.com/2015/09/02/node-mocha-travis-istanbul-coveralls-unit-tests-coverage-for-your-open-source-project/)

Contributor

• Bihame Sikubwabo Vainqueur