Table of Contents
Crib is a house management app designed for shared living. Built by and for hackers, it helps roommates stay organised by combining voting, affirmations, chore tracking, and one-time secret sharing โ all in one sleek dashboard with Discord integration.
Originally created for Hack Clubโs Neighborhood program, Crib acts like a dorm-room โbig brotherโ system: log complaints with upvotes/downvotes, share sensitive info via one-time links, track availability, and vote on house leaders using an Elo-style ranking system.
To get a local copy up and running, follow these steps:
- Node.js and npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/austindelic/crib.git cd crib
- Install NPM packages
npm install
- Create a
.env
file based on.env.example
cp .env.example .env;
- Populate the
.env
file with your environment variables - Start the development server
npm run dev
- Visit http://localhost:5173 to view the app.
-
Update Drizzle Table Schema:
npx drizzle-kit push
-
See
scripts/seed-tools.ts
for database seeding. Example:bun .\scripts\seed-tools.ts r
- Feature 1
- Feature 2
- Feature 3
- Nested Feature
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the Creative Commons Attribution-NonCommercial 4.0 International License. See LICENSE.txt
for more information.
Austin Delic - austin@austindelic.com
Project Link: https://github.com/austindelic/crib