This website allows UIUC students to find the perfect roommate match instead of having to scroll through many profiles in the current UIUC roommate pairing application. The website collects their personal habits along with their preferences for roommates:
- Adds them to the database with their user info and preferences
- Runs the matching algorithm
- And displays the top roommate matches on a new page for the user to see
For more details, view the full project proposal here.
- Julie Lima: Worked on the backend and databases
- Vineetha Gurrala: Worked on the frontend design
- Ayush Sharma: Worked on connecting the backend and frontend
- Peter Nguyen: Worked on the matching algorithm
Navigate to your source directory, and run the following command.
python3 -m venv ./venv
Before running any code, run the following:
venv/Scripts/activate/
To enable package updates, run the following command ONCE:
pip install pipreqs
To update packages, run the following from the home directory:
pipreqs . --force
To install packages, run the following:
pip install -r requirements.txt
- To configure Notion for later reading:
python src/ics.py configure notion <database_id> <api_key>
Note, you must create:
- an integration. Use its "Internal Integration Token" as the
api_key
. - a new database page, and clear all rows & columns (except the name column). Use this page's id as the
database_id
.
Detailed instructions on obtaining these parameters can be found here: https://developers.notion.com/docs/getting-started.
- To add links for LMS:
python src/ics.py add <link> <lms>
- To read and get your data:
python src/ics.py read [notion | todoist]
- To access your assignments into Todoist, follow the instructions here to import the "new_data.csv" file to a Project. You can repeatedly import this file as it updates and Todoist will automatically merge them for you.