shack

shack is a solution to help roommates live harmoniously together. Create a roommate agreement for your household and easily access the agreement details through your dashboard instead of looking up various PDFs and emails. Users also have the option to create household-wide notes, for those times when a post-it on the fridge isn’t enough.

Tech stack

• Front End: React + TypeScript, Chakra UI for component library
• Back End: PostgreSQL, API only Ruby on Rails

Screenshots

Roommate Agreement Information Page

Walkthrough of Roommate Agreement Form

Generated Roommate Agreement PDF, hosted on S3 and served through Cloudfront

Installation

1. Download, install and run the API (instructions)
2. Download/clone this repository
3. cd into the directory and run npm install
4. Once packages are installed, run npm start

Note

This project is my capstone project for Lighthouse Labs and some of the features might not be fully implemented.