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.

Build status

Required 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.

Extra Feature

• User can report a car advert

Useful Links

• This project is being managed with Pivotal Tracker
• The UI templates are hosted here Github pages
• The API URL has been succesfully deployed to heroku. It can be accessed here

Technologies

• NodeJS A run time environment based off Chrome's v8 Engines for writing Javascript server-side applications.

• Express Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

• ES Lint A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.

• Babel Babel is a JavaScript compiler. Babel is a toolchain that is mainly used to convert ECMAScript 2015+ code into a backwards compatible version of JavaScript in current and older browsers or environments.

Tools

• Postman Postman is the only complete API development environment, and flexibly integrates with the software development cycle.
• Swagger Swagger aides in development across the entire API lifecycle, from design and documentation, to test and deployment.
• Testing
  • Mocha Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
  • Chai Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
• Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.
• Cloudinary is a cloud-based image and video management solution. It enables users to upload, store, manage, manipulate and deliver images and video for websites and apps.
• Travis CI is a hosted, distributed continuous integration service used to build and test software projects hosted at GitHub.
• Coveralls Coveralls is a hosted analysis tool, providing statistics about your code coverage.
• CodeClimate provides automated code review for test coverage, maintainability and more so that you can save time and merge with confidence.

Installations

Getting Started

• You need to have node installed on your system
• You need to have a cloudinary account in order to get an API secret as well as an API key.

Clone

• To clone this repo, you need to open a command line terminal and run : git clone https://github.com/NonsoAmadi10/Auto-Mart.git

Install

• Install all depencies used in this project by running npm install

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

  • PORT - An Integer specifying the PORT your application will run on.
  • JWT_SECRET - A random string used for generation authorization tokens.
  • CLOUDINARY_NAME => your name on cloudinary
  • CLOUDINARY_API_KEY=> your cloudinary_ secret key
  • CLOUDINARY_API_SECRET=> your cloudinary secret

Starting the server locally

• Run npm run dev-start to start the server

Testing App with Postman

• Open postman
• Test with api endpoints found here

Testing with mocha and chai

• Run npm test to see test pass locally

Author

• Amadi Justice Chinonso

Acknowledgement

• I learned how to use swagger using this resource
• I learned how to upload to cloudinary using this article