Open-source team collaboration for student organizations on a budget

Pebble was born out of necessity at FIU SEDS (Students for the Exploration and Development of Space) when we realized that existing team collaboration tools were simply too expensive for student organizations with limited budgets. Instead of compromising on functionality, we decided to build our own open-source solution that any student organization can use, modify, and contribute to.

This project is currently in active development for a hackathon. Do not run production deployments yet as the application is not ready for full-scale use. We're building this iteratively and welcome contributions from the community!

• 100% Free & Open Source - No subscription fees, no per-user costs
• Built by Students, for Students - We understand the unique challenges of student organizations
• Simple & Focused - Task management without the bloat of enterprise tools
• Real-time Collaboration - See changes instantly across all team members
• Self-Hostable - Own your data and control your costs
• Hackathon Ready - Built with rapid development and iteration in mind

• Real-time task collaboration - See updates instantly across all team members
• User attribution - Track who created and completed each task
• Simple task management - Add, complete, and delete tasks with ease
• Responsive design - Works seamlessly on desktop and mobile
• Zero setup complexity - Just enter your name and start collaborating
• Open source - Fork, modify, and contribute back to the community

• Frontend: Typescript, JavaScript, Next.Js
• Database: Prisma ORM with PostgreSQL
• Real-time: WebSocket connections for live updates
• Hosting: Vercel
• Authentication: Auth0

Frontend (Vanilla JS) → API Layer → Prisma ORM → PostgreSQL Database
                     ↓
               WebSocket Server (Real-time updates)

• Node.js (v16 or higher)
• PostgreSQL database
• npm or yarn

1. Clone the repository

   git clone https://github.com/marci0garcia/pebble.git
   cd pebble

2. Install dependencies

   npm install

3. Set up your database

   # Set up your DATABASE_URL in .env file
   echo "DATABASE_URL=postgresql://username:password@localhost:5432/pebble" > .env
   
   # Run Prisma migrations
   npx prisma migrate dev
   npx prisma generate

4. Start the development server

   npm run dev

Self-hosting costs may apply depending on your infrastructure choices

1. Join a session - Enter your name to start collaborating
2. Add tasks - Type in the input field and hit Enter or click Add
3. Complete tasks - Check the checkbox to mark tasks as done
4. Delete tasks - Click the × button to remove tasks
5. See live updates - Watch as teammates add and complete tasks in real-time

• Basic task CRUD operations
• Real-time collaboration
• Simple user system
• Prisma database integration
• WebSocket real-time updates

• User authentication with email/password
• Project/workspace separation
• Task assignments and due dates

• Google Drive integration
• Email notifications
• Offline support
• Custom themes and branding
• Plugin system
• Advanced reporting

We welcome contributions from student developers and organizations! This project is built by the community, for the community.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Test your changes
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

• Keep it simple - remember our target users are students with varying technical backgrounds
• Write clear commit messages
• Test your changes locally
• Update documentation when needed

• FIU SEDS (Students for the Exploration and Development of Space) - Founding organization
• Add your organization here by opening a PR!

MIT License - Feel free to use, modify, and distribute. See LICENSE for details.

• FIU SEDS - For the inspiration and initial use case
• The Student Developer Community - For believing that great tools shouldn't break the bank
• Open Source Contributors - This project exists because of your contributions

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: mgarc1070@fiu.edu

Built with ❤️ by students, for students. Because great ideas shouldn't be limited by budget constraints.