aaronspindler / roomscout Goto Github PK

A web app for finding and managing roommates

License: MIT License

Python 45.29% HTML 31.05% CSS 6.17% Shell 0.05% Less 5.99% SCSS 5.99% Stylus 5.46%

roommate finder management roommatefinder roommatemanagement bill billing-application bill-management house-automation house

roomscout's Introduction

RoomScout

The site has been taken down as a result of covid-19 and facebooks new roommate features in marketplace.

RoomScout is a one stop shop for finding and managing roommates

Setup

Download repo
Install pip requirements using pip install -r requirements.txt
Setup environment variables
Start django local server using python manage.py runserver

Environment Variables

Settings for the application are now loaded from environment variables even in development environment, you can also use a local_settings.py file to load settings easier. An example of this file format is in Resources folder

SECRET_KEY : Required
GOOGLE_API_KEY : Optional for google maps
RECAPTCHA_PUBLIC_KEY : Optional for captcha
RECAPTCHA_PRIVATE_KEY : Optional for captcha
AWS_ACCESS_KEY_ID : Optional for S3 Storage and Rekognition
AWS_SECRET_ACCESS_KEY : Optional for S3 Storage and Rekognition
WALK_SCORE_API : Optional for Walk Score
EMAIL_HOST : Optional for email
EMAIL_HOST_USER : Optional for email
EMAIL_HOST_PASSWORD : Optional for email
STRIPE_KEY : Optional for stripe transactions
STRIPE_SECRET_KEY : Optional for stripe transactions

Branches

Master

https://roomscout.ca
Deploys directly to production upon commit

Dev

https://roomscout-dev.herokuapp.com
Deploys directly to development server

All Other

Any other branch should be a feature branch
All feature branches should make pull requests into dev and then once approved the dev branch will be merged to master

Testing

All code that is pushed should have tests included for it, if tests are not present it is something that can be done by anyone

Forms

Views

This is the basic format that tests for views should follow

def test_FUNCTION_get(self):
	print('Testing FUNCTION() GET')
	self.client.force_login(self.user)


def test_FUNCTION_get_not_logged_in(self):
	print('Testing FUNCTION() GET not logged in')
	self.client.logout()


def test_FUNCTION_get_wrong_user(self):
	print('Testing FUNCTION() GET wrong user')
	self.client.force_login(self.user2)


def test_FUNCTION_post(self):
	print('Testing FUNCTION() POST')
	self.client.force_login(self.user)


def test_FUNCTION_post_not_logged_in(self):
	print('Testing FUNCTION() POST not logged in')
	self.client.logout()


def test_FUNCTION_post_wrong_user(self):
	print('Testing FUNCTION() POST wrong user}')
	self.client.force_login(self.user2)

Models

roomscout's People

Contributors

Stargazers

Watchers

Forkers

doxxxxxx josylad samraiman fducom fastlyos

roomscout's Issues

Write tests for all existing code

Design profile questions for users

Detect if user is a student based on their email address

Add ability to choice image display order for rooms

Add bill notify day to house

Phone number verification

Add search framework

Haystack, some sort of full text search

Add functionality to leave a house

This should be fairly straightforward, just make an endpoint that:
checks if user is trying to remove themselves
then make them confirm
then finally remove them as a member from the house

Implement celery best practices

Best practices can be found here: https://blog.daftcode.pl/working-with-asynchronous-celery-tasks-lessons-learned-32bb7495586b

Enable social media login

Currently being worked on in https://github.com/xNovax/RoomScout/tree/SocialAccounts

Continuous Integration

Get Travis.ci working

Add functionality for custom bill split

Compress static media files

Compress the static images on the homepage so it loads faster

Fix American addresses not working because of issue with response type varying from component form type

This can be done by just receiving the place id and then getting the other required information after

Add way for users to track which rooms they inquired about

Javascript Room Like POST

I am trying to get the room like javascript functions to use POST instead of GET but I can't figure it out.

I am trying to convert it to this format

Securely store bill files, either store files in DB encoded or somehow use keys with S3

Need to find a way to securely store users sensitive information such as bills that contain their full name, address, and account information.

Thinking that this can be accomplished by encoding the files into text and then storing the text in a database, or saving the files on S3 Private and then using tokens in URL to allow user to view the file.

Predict future bills

Predict future bills based on what bills the house has already published

Make settings more streamlined

The goal is to have dev and production setting stay in the same settings file and then in dev environment the settings can be read from local_settings and production settings can be loaded with environment variables

Premium Features

Features:

private houses
Increased number of houses managed