AutoMart

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.

Pivotal Tracker

Project is currently being built with the Project Management Tool; Pivotal Tracker. You can find the stories at https://www.pivotaltracker.com/n/projects/2345980

Template Link

Template is hosted at https://an-apluss.github.io/AutoMart/UI/index.html

API Deployment

API is deployed at https://web-automart.herokuapp.com

Built With

• NodeJS
• ExpressJS
• HTML
• CSS
• JavaScript

Getting Started

Installation

• Clone this repository using git clone https://github.com/an-apluss/AutoMart.git .
• Use the .env.example file to setup your environment variables and rename the file to .env
• Run npm install to install all dependencies
• Run npm start to start the server

Supporting Packages

Linter

• ESLint - Linter Tool

Compiler

• Babel - Compiler for Next Generation JavaScript

Test Tools

• Mocha - JavaScript Test Framework for API Tests (Backend)
• Chai - TDD/BDD Assertion Library for Node
• Chai-http - A Chai plugin for testing node.js HTTP servers
• Istanbul(nyc) - Code Coverage Generator

• Run Test

npm test

• Run Coverage Report

npm run coverage

API Routes

DESCRIPTION	HTTP METHOD	ROUTES
Sign up User	POST	/api/v1/auth/signup
Log in User	POST	/api/v1/auth/signin
Create a car sale ad	POST	/api/v1/car
Create a purchase order	POST	/api/v1/order
Update the price of a purchase order	PATCH	/api/v1/order/{order-id}/price
Mark a posted car Ad as sold	PATCH	/api/v1/car/{car-id}/status
Update the price of a car	PATCH	/api/v1/car/{car-id}/price
View a specific car	GET	/api/v1/car/{car-id}
View all unsold cars	GET	/api/v1/car?status=available
view all unsold cars within a price range	GET	/api/v1/car?status=available...
		...&min_price=XXXValue...
		...&max_price=XXXValue
Delete a specific car Ad	DELETE	/api/v1/car/{car-id}
View all posted ads whether sold or available	GET	/api/v1/car
flag/report a posted AD as fraudulent	POST	/api/v1/flag/
View all unsold cars which state reads new	GET	/api/v1/car?status=available&state=new
View all unsold cars which state reads used	GET	/api/v1/car?status=available&state=used

Project References

• I learnt how to persist data and structure my project from a video tuturial by Bolaji Olajide - https://www.youtube.com/watch?v=WLIqvJzD9DE
• I learnt how to used bycrpt, jwt and Joi dependencies and how to capture the big picture of an application before writing code, from a video course created by Mosh Hamedani - Node.js: The Complete Guide to Build RESTful APIs (2018)
• Stackoverflow was also a blessing whenever I come across question I can't answer
• Google

License

© Anuoluwapo Akinseye

Licensed under the MIT License