Property Pro Lite

Project Overview

Property Pro Lite is a platform to buy and sell properties across the world.

Features

• A user can create an account if he doesn't have one
• A user can log in to his account if he does have it
• A user can view all listed properties to buy
• A user can view more details about the property listed
• A user can sell a property
• A user can buy a property
• A user can log out to his account
• An admin user can update his listed property
• An admin user can delete his listed property
• An admin user can mark his property as sold
• User can reset his/her forgoten password

Demo

Built With

• Node.js
• Express framework
• Html
• CSS
• Javascript

Api Endpoints

• POST /auth/signup  - Create user account 
• POST /auth/signin  - Login a user
• POST /property  - Create a property ad
• PATCH /property/<:property-id>  - Update property data
• PATCH /property/<:property-id>/sold  - Mark a property as sold so users know it’s no longer available​.
• DELETE /property/<:property-id>  - Delete a property advert.
• GET /property/<:property-id>/  - Get all property adverts
• GET /property/me - Get all your property adverts
• GET /property/<:property-id>?type=​propertyType - Get all property advertisement offering a specific type of property. 
• GET /property/<:property-id>  - View a specific property advert. 

API documentation

The documenation of the API can be found at : https://property-pro-lite-amily.herokuapp.com/api-docs

Known Issues

API is on point, i.e all endpoints works fine, but

• The client side doesn't have API links implemented yet, so you can query the api using your browser or postman.
• The data is not persisted on the database yet, i.e if you restart the application the data are erased.

Installation

• Run git clone https://github.com/amilykassim/PropertyProLite.git
• Run cd Property Pro Lite to navigate to the project directory
• Run npm install to download and install all packages
• Run npm start to start the server
• And then Test the end points using postman or your browser

Contributing

You can contribute to this project by forking the project github.com/amilykassim/PropertyProLite.git

And then submit your changes by creating a new pull request github.com/amilykassim/PropertyProLite/compare

License

• MIT license
• Copyright (c) AMILY Kassim