Kukodi is an app that allows a property owner to manage his/her rental properties with ease> A propert owner can register their properties, houses on the properties and tenants, and tenants can recieve monthly bills, make payments through the app.
- Python3
- Flask
- Postman
- Pytest
- Git
- Python3 pip
- PostgreSQL database
-
Clone the repo
https://github.com/MurungaKibaara/Kukodi/
-
Checkout delelop branch
git checkout develop
-
python3
sudo apt-get install python3
-
install python3 pip
sudo apt-get install python3-pip
-
install vitual environment
pip3 install virtualenv
-
checkout develop branch
git checkout develop
-
create the virtual environment
virtualenv env
-
Activate the vitualenv in the parent directory of your "env"
source env/bin/activate
-
Install requirement
pip install -r requirements.txt
-
Run the app
python3 run.py
-
Testing
python3 -m pytest
| Endpoints | Functions |
| -------------------------------------------------| :------------------------------------: |
| POST/api/landlord/registration | create property owner account |
| POST/api/landlord/login | login property owner |
| POST/api/landlord/logout | logout proprty owner |
| POST/api/tenant/registration | create tenant account |
| POST/api/tenant/login | login tenant |
| POST/api/tenant/logout | logout tenant |
| POST/api/v1/property | Add a new property |
| GET/api/v1/property | View all properties |
| GET/api/v1/property/<id> | View a property by id |
| GET/api/v1/property/<name> | View a property by name |
| POST/api/v1/houses | Add a new house |
| GET/api/v1/houses |View all houses in a particular property|
| GET/api/v1/houses/<id> | View a houses by id |
| GET/api/v1/houses/<house_no> | View a houses by house number |
| POST/api/v1/payments | Process rent payment using mpesa |
| GET/api/v1/payments | View all payment records |
| GET/api/v1/payments/<id> | View a payment record by id |
| POST/api/v1/bills | Create bills |
| GET/api/v1/bills | View all existing bills |
| GET/api/v1/bills/<id> | View a house by id |
| POST/api/v1/complaints | Tenants can post complaints |
| GET/api/v1/complaints | Property owner can view all complaints|
| GET/api/v1/complains/<id> | property owner can view one coomplaint |
Murunga Kibaara