Property Deals

The purpose of this application is to provide a platform where people can post properties for sale or rent e.g Houses.

Getting Started 🚀

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites 📋

You'll need Git and Python (which comes with pip) installed on your computer.

python@3.6.0 or higher
pip@20.0 or higher
git@2.20.0 or higher

---

How To run application 🔧

Don't forget to create a virtual environment and activate.

From your command line, first clone property-deals:

This command works on Linux and Mac and Windows

# Clone this repository
git clone https://github.com/devsbranch/property-deals.git

# Go into the repository
cd property-deals

Then you can install the dependencies using PIP:

On Linux and Mac

# Install dependencies
$ pip3 install -r requirememts.txt

# Start development server
$ python3 run.py

On Windows

Use Powershell, Command Prompt or Windows Terminal

# Install dependencies
PS> pip install -r requirememts.txt

# Start development server
PS> python run.py

##Setting Up the Database Once you run the application for the first time, it will automatically create an SQlite database file if that's what is configured. Otherwise, you have to create a database. A Postgres database is preferred but feel free to use whichever you want.

Connection String

In your application, you have to configure the flask application to use the Postgres database. Your connection string format should be like this: postgresql+psycopg2://<user>:<password>@<host>:<port>/<database> You have to set a password for connecting to Postgres or else Valentina Studio won't connect. Here is an example on a connection string postgresql+psycopg2://postgres:postgres@localhost:5432/property_deals

To start using the app, start the server has and go to this url http://localhost:5000/ and you will see the website running on a Development Server and will show you the index/home page. Click on register to sign up.

Fill in your login credentials you used to sign up and click login.

Once logged in you can browse through the application and test some features. You can open a PR for some features you think should be added.

Technologies used 🛠️

• Flask - A Python Web Development Framework
• PostgreSQL - PostgreSQL is a free and open-source relational database management system system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads.

Features

• DBMS: SQLite, PostgreSQL (production)
• DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
• Session-Based authentication (via flask_login), Forms validation
• Deployment scripts: Docker, Gunicorn / Nginx, Heroku

Authors

• Jachin Manda (Lead Developer)
• Alison Mukoma

Status

Still under development