NYU Roomate Finder is a simple web app that easily connects students looking for roomates with similar preferences so that they can start looking for an apartment together.
At NYU, students looking to transition out of the dormitories often have problems finding good roommates. The NYC apartment search can be quite cutthroat, so preferences must be laid out far in advance before signing a lease. Even if a student finds a potential roommate, they often have to make sacrifices during or after signing a lease when they suddenly find that their preferences don't match up. They might be strict about their share of the rent, but not want some "morning person" making a ruckus at 5am. We wanted to build a platform that allows students to find roommates from a large pool of potential candidates who are also currently looking, so that they can quickly find the best match, and initiate a conversation with them. Ultimately, this will allow students to start looking for an apartment as soon as possible, not just with those that qualify, but with those who are the best possible matches for them. It's kind of like Tinder, but for roommates.
The user starts by filling out a form with their preferences for a roomate, such as their desired rent range, and whether or not they are a morning person. They can also set strict "dealbreaker," such as only wanting to room with someone the same gender as them. The user is then shown a list of their top matches, and are able to filter by additional criteria if so desired. The user will be free to view the profiles (and full preferneces) of the potential candidates, and initiate a private chat with them if so desired.
To contribute to this project, please see the CONTRIBUTING.md document and strictly adhere to our protocols.
To test run "npm test" on the back-end folder.
To run the project run "npm install" on the front-end and the back-end folder to make sure you have all the dependencies. Next, make sure you have put our .env file from our Discord channel in the back-end folder. Feel free to change the database (DSN) credentials to your own database. Finally run "pm2 start npm -- start" on both the front-end and back-end folders for deploying. \