Skip to content

knaiskes/housesPortal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

housesPortal

A Web application for promoting houses online.

The backend of the project is written in Python (Django) while the frontend is written in ReactJS and Bootstrap 4.

Video Overview

housesPortal Video Overview

Dependencies

  • Python 3.x
  • Node.js for ReactJS
  • Docker & Docker-Compose for PostgreSQL and pgAdmin

Arch

$ sudo pacman -S nodejs docker docker-compose

Quick Start

Clone project

$ git clone [email protected]:KNaiskes/housesPortal.git

Start Docker - pull images

$ sudo systemctl start docker
$ sudo docker-compose up

Install Python - backend dependencies

$ cd housesPortal
$ python -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Migrate database models

$ python housesPortal/manage.py makemigrations
$ python housesPortal/manage.py migrate

Install ReactJS - frontend dependencies

$ cd housesPortal/frontend
$ npm install

Start project

$ sudo docker-compose up # Start database
$ cd housesPortal/frontend/src && npm start # Start frontend
$ python housesPortal/backend runserver # Start backend

API paths

Path Description
houses/ Returns all the available houses from the database
houses/ Returns the one house with the specified id
houses/images/ Returns all the images for the specified house
houses/landlords Returns all the available landlords from the database
houses/landlords/ Returns the one landlord with the specified id