📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Tafuta Nyumba

Tafuta nyumba is a USSD application that allows users to search houses, hostels, and business premises near them. It also allows realtors to list their properties

🛠 Built With

Tech Stack

Client

• Flask
• Docker

Database

• PostgreSQL
• Redis

Key Features

• [List property]
• [Rent property]
• [Buy property]

(back to top)

🚀 Live Demo

• Coming soon

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/kennankole/tafuta-nyumba.git

Install

Install this project with:

  cd tafuta-nyumba
  pipenv install

Usage

To run the project, execute the following command:

  pipenv run

Run tests

To run tests, run the following command:

  pytest

(back to top)

👥 Authors

👤 Author 1

• GitHub: @kennankole
• Twitter: @obwombe_kennedy
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Mobile Application]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly give it a ⭐️

(back to top)

📝 License

This project is MIT licensed.

(back to top)