Skip to content

CMUHousing

The CMU Housing project hosted at https://cmuhousing.com serves as the obvious choice for CMU students to look for Housing. Search for the perfect dorm, explore ratings and reviews from real students, and find your roommate all in one website.

Production also deploys via Kennel to https://cmuhousing.scottylabs.org.

Getting Started

Prerequisites

Setup

For detailed setup instructions, see CONTRIBUTING.md.

Terminal window
direnv allow

Running the Frontend & Backend

Both the frontend and backend are run via devenv, using the following command.

Terminal window
devenv up

The backend is proxied through the Vite development server and can be accessed at http://localhost:3000 during development. The backend should not be accessed directly, as all paths prefixed with /api will be routed to the backend.

Contributing

Please read CONTRIBUTING.md before you contribute to this project!