michaelroudnitski / yuroomie

A Django website to help students find roommates

YURoomie

YURoomie is a dynamic Django website created for York University's annual 2 day hackathon (Steacie Library Hackfest 2018).

The website was created for the purpose of helping students find roommates attending the same school.

Getting Started

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

Prerequisites

Python 3.6

pip

virtualenv (Not necessary but highly recommended)

Django 2.0.2

Pillow (PIL is the Python Imaging Library by Fredrik Lundh and Contributors.)

Installing

Open powershell/terminal

Installing virtualenv and setting one up (after you've installed Python with pip in your system environment variables path)

>>> pip install virtualenv
>>> cd virtualenv/desired/location
>>> virtualenv name_of_your_virtual_env

Activate your virtualenv

>>> cd name_of_your_virtual_env

for windows: >>> scripts/activate

mac/linux: >>> source bin/activate

Install Django

>>> pip install django==2.0.2

Install Pillow

>>> pip install pillow

Clone the repo into your virtualenv

>>> git clone https://github.com/michaelroudnitski/yuroomie

Now you're ready to run the server and access the website

>>> cd yuroomie
>>> python manage.py runserver

Now just localhost:8000 in your browser

Built With

• Django - The web framework used
• Bootstrap 4 - Frontend library

Authors

• Michael Roudnitski - Project lead and fullstack development

• Adam Zanon - Backend Development

• Christian Augustyn - Frontend Development

• Manpreet Saini - Frontend Development

• Michael D'errico - Frontend Development

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Thanks to York University for hosting an excellent Hackfest2018

Screenshots