Property Pro Lite is a platform where people can create and/or search properties for sale or rent.
To get the project up and running on your local machine, please follow these instructions.
Make sure you have node -v 10 and above installed Or follow these steps to install node
Node installation on OS X
$ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
Node installation on Linux
sudo apt-get install python-software-properties
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
Node installation on Windows
Download the intaller from the official Node.js website
$ git clone https://github.com/alfredruhara/property-pro-lite
$ npm install
$ npm start
Testing and Getting the code coverage report with nyc
$ npm test
Testing the code style with eslint
$ ./node_modules/.bin/eslint server
- User
- Home page
- Specific Property page
- Agents page
- Sign and Sign up pages
- Agent
- Own Properties page
- Create AD page
- Edit property page
- Trade page
- Profile page
| Method | End point | Public | Action |
|---|---|---|---|
| GET | user/ | True | get all users as agents with their informations available |
| POST | auth/signup | True | Create a new user |
| POST | auth/sign | True | Login the user |
| PATCH | user/ | False | Edit user information |
| PATCH | user/changepassword | False | Change password |
| PATCH | user/changeavatar | False | Change avatar |
| Method | End point | Public | Action |
|---|---|---|---|
| POST | property/ | False | Post an advert - publish |
| PATCH | update/:id | False | Edit a property |
| DELETE | property/:id' | False | Delete a property |
| PATCH | property/:id/sold | False | Mark a property as trade |
| PATCH | property/:id/unsold | False | Mark a property as untrade |
| GET | property/ | True | Get all adverts properties |
| GET | property/view/<property_id> | True | Get a specific property |
| GET | property/agent | False | Agent account - Get all his properties |
| GET | property/agent/sold | False | Get all adverts properties mark as trade for the agent |
| GET | property/filter/?location=&type=&bathrooms=&bedrooms | True | Filter and search Result |
The official documenation of the API can be found at : https://property-lite-pro.herokuapp.com/api-docs/
The application template is hosted on github pages
https://alfredruhara.github.io/property-pro-lite/UI/
- Use any email and password to access other pages
- Interact with the application template to discover other activities
The application server has been hosted on Heruku:
The development phases of the project (project stories) are on pivotaltracker : https://www.pivotaltracker.com/n/projects/2354593
- Chadrack ruhara
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent