Crib

crib.

Shared living, simplified.
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

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.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

• Node.js and npm

  npm install npm@latest -g
  

Installation

1. Clone the repo

   git clone https://github.com/austindelic/crib.git
   cd crib
   

2. Install NPM packages

   npm install
   

3. Create a .env file based on .env.example

   cp .env.example .env;
   

4. Populate the .env file with your environment variables
5. Start the development server

   npm run dev
   

6. Visit http://localhost:5173 to view the app.

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)

Contact

Austin Delic - austin@austindelic.com

Project Link: https://github.com/austindelic/crib

(back to top)

Acknowledgments

• README.md Template
• README.md Badges

(back to top)