da-stoi / herder

A roommate searching app that ranks possible roommates by how closely they match the questions you answer.

Herder

A roommate searching app that ranks possible roommates by how closely they match the questions you answer.

Herder is very much in beta, things will break! When they do, please please please let me know. Contact details can be found on the website.

If you are an incoming or current WPI student, check the Announcement channel on the WPI Class of 2025 Discord server.

How to use

1. Login with Discord
2. Go to Profile, and select Edit Profile. Then fill in as many questions as possible and press save changes.
3. Go to Search, select what kind of roommate you are looking for and click Search.
4. That's it! 📈 Now you can see the percentage of how closely you match with other people. You can find a person's discord username and digits on their profile card so you can reach out.

Planning to contribute?

Environment Variables

Variable	Description
NEXT_PUBLIC_DISCORD_AUTH_URI	Discord auth page URI
DISCORD_REDIRECT_URI	Oauth2 Redirect
DISCORD_CLIENT_ID	Discord oauth2 app client id
DISCORD_CLIENT_SECRET	Discord oauth2 app client secret
DATABASE_URL	PostgreSQL database connection url

All API requests require a x-access-token header, with the exception of the oauth2 redirect.

Oauth2 Redirect

GET /oauth/redirect

Redirects to auth page after converting oauth2 code to access token.

Query Parameters

Param	Description	Required
code	Oauth2 code	true

Match

GET /match

Returns JSON array of matching users with their percent match.

Query Parameters

Param	Description	Required
grad_year	Graduation year	true
pronouns	Pronouns	true

Questions

GET /questions

Returns JSON object of all profile questions.

Profile

GET /user/profile

Returns requesting user's full profile.

Update Profile

POST /user/update-profile

Body should contain all profile questions answered by the user.

Returns updated profile.

Get Residence Halls

GET /halls

Returns JSON array of all residence halls.

Get Rooms

GET /halls/{hall_id}/rooms

Returns JSON array of all rooms in a specified residence hall.

Parameters

Param	Description	Required
hall_id	Residence Hall Id	true

Match

GET /roommates/neighbors

Returns JSON array of all users in the same residence hall.

---

Made with ❤️ by Daniel Stoiber
Thank you everyone on the WPI Class of 2025 server!

herder's Issues

Allow selecting multiple pronoun values on Search page?

It'd be nice to be able to see all matches on the Search page irrespective of their pronouns.
The values could be passed like so:
one selection

• He/Him
• She/Her
• They/Them

returns he

multiple selections

• He/Him
• She/Her
• They/Them

returns he,they

and the passed strings could be parsed with a simple value.split(',') and queried individually or with a union? (I don't really know how database stuff works)

Add check to make sure that the user is inside the guild

User auth should have a check to make sure that the authenticated user is a member of the configured discord guild, to prevent spam and abuse

Not able to paste in Bio field.

Current behavior: When trying to paste text longer than 230 characters in the Bio field it will simple not let you.
Intended behavior: Cuts off text beyond 230 characters.

Change text in match comparison based on pronouns

When matching with a roommate, currently if they indicate a level of preference for a question, Herder says this is not very/kind of/very important to them. We ask for their pronouns in their profile so this is a perfect place to use that data for slightly nicer grammar.