Skip to content

Latest commit

 

History

History
76 lines (62 loc) · 2.3 KB

README.md

File metadata and controls

76 lines (62 loc) · 2.3 KB
Raw

PropertyPro-Lite

Build Status Coverage Status Maintainability

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

SETTING UP ENVIRONMENT

$ brew install node

check if it's available

$ node -v

you must have also git client

$ git --version

now clone repo

$ git clone https://github.com/mucyomiller/PropertyPro-Lite.git

Install deps

with yarn or npm

 ~/Users/mucyofred/PropertyPro-Lite$ npm install

Start the server

 $ npm start

Tests & Linting

for running test do

 $ npm test

for linting do

$ npm lint

API ENDPOINTS

BASEURL : /api/v2/

AUTHENTICATION END POINTS : /auth/

HTTP METHOD END POINT AUTHENTICATED DESCRIPTION
POST /signup False Create a New User
POST /signin False Authenticate The User

PROPERTIES End POINTS

HTTP METHOD END POINT AUTHENTICATED DESCRIPTION
GET /properties False Get all Properties
GET /property/:id False Get specified property by id
GET /property?type=name False Get propertyies by type
POST /property True Create a Property
PATCH /property/:id True Update a Property
PATCH /property/:id/sold True Mark Property as Sold
DELETE /property/:id True Delete a Property

Heroku

The application API is hosted on this dyno URL: https://mucyo-property-pro-lite.herokuapp.com/api/v2

Github Pages

The application UI is hosted on this gh-pages URL: https://mucyofred.com/PropertyPro-Lite/UI/

Developer

Mucyo Fred <me@mucyofred.com>