Git Product home page Git Product logo

auto-mart-website's Introduction

AUTO-MART

Build Status Coverage Status Maintainability

Auto Mart is an online marketplace for automobiles of diverse makes, version or body type. With Auto Mart, sellers can promote their vehicles or buy from trusted dealers


UI

User Interface (UI)

  • HTML
  • CSS
  • Javascript

GitHub Pages link for UI

AutoMart/UI link


SERVER

API ENDPOINTS

Ressource URL Methods Description
/automart GET swagger documentation
/api/v1/auth/signup POST Get the user to signup
/api/v1/auth/login POST Get the user to login
/api/v1/car POST Get the user to post a car sale advertisement
/api/v1/order POST Get the user to make a purchase order
/api/v1/cars/:id/ PATCH Get the user to update the price of his/her posted car sale ad
/api/v1/order/:id PATCH Get the user to update the price or his/her purchase order
/api/v1/car/:id PATCH Get user to mark his/her posted AD as sold
/api/v1/car/:id GET Get user to view a specific car
/api/v1/cars/available GET Get user to User can view all unsold cars
/api/v1/cars/available/range GET Get the user to view all unsold cars within a price range
/api/v1/cars/posted GET Get the Aamin to view all posted ads whether sold or unsold
/api/v1/cars/available/used GET Get the user to view all used unsold cars
/api/v1/cars/available/new GET Get the user to view all new unsold cars
/api/v1/car/:id DELETE Get the admin to delete a posted AD record

Used Tools

Language

*Javascript*

Server Environment

 *NodeJS* (run time Environment for running JS codes)

Framework

 *Express* (used for building fast APIs)

Testing Framework and assertion library

 *Mocha* and *Chai*

Continuous Integration

Travis CI

Test Coverage

nyc

Git badge

coveralls

Deployment

Heroku

Heroku link Example

AutoMart heroku link

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To install the software on your local machine, you need first to clone the repository https://github.com/teejohn247/Auto-Mart-Website or download the zip file and once this is set up you are going to need this packages. [NodeJS]

 [Node Package Installer - NPM] this usually comes with Node or YARN in case NPM doesn't work.

Installing

The installation of this application is fairly straightforward, After cloning this repository to your local machine,CD into the package folder using your terminal and run the following

> npm install

It will install the node_modules which will help you run the project on your local machine.

Run the server

> npm start

Run the test

> npm test

Author


License & copyright

Copyright (c) Tolu Ajuwon

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.