/PropertyProLite-CH2

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

PropertyProLite-CH2

Build Status Maintainability Coverage Status

Project Overview

Property Pro Lite is a platform where people can create and/or search properties for sale or rent.

Endpoints covered

Method Endpoint Description
POST /auth/signup User create an account
POST /auth/login User login to their account
POST /auth/reset User reset thei password
POST /property Agent post property advert
PATCH /property/<:property-id> Agent update their property advert
PATCH /property/<:property-id>/sold Agent mark their advert as sold
DELETE /property/<:property-id> Agent delete their advert
GET /propertys get all property adverts
GET /api/v1/property?type=propertyType get all property adverts of specific type
GET /property/<:property-id> get a specific advert
POST /property/<:property-id>/fraudulent User mark an advert as fraudulent

Tools Used

  • Language: Javascript
  • Server environment: Node.js
  • Back-end framework: Express
  • Testing library: Mocha.js
  • Assertion library: Chai

Github-Pages Link

https://burnerb.github.io/PropertyPro-lite/UI/index.html

Pivotal Tracker story board

https://www.pivotaltracker.com/dashboard

Getting Started

Setting up your system

Make sure you already have Node.js installed in your system..

How to get started

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 this will start your application and run on port 5000

Run the tests

npm test