Skip to content

πŸŽ‰ Get your estimation party started with confetti, the ultimate tool for a festive and productive estimate session

License

Notifications You must be signed in to change notification settings

awtkns/confetti

Repository files navigation

Confetti

πŸ₯³ Get your estimation party started with confetti πŸ₯³
Realtime estimation with confetti-filled fun. The party tool for your planning process.

Deployment Success Health Check License Node version

πŸ”— Short link Β Β β€’Β Β  🀝 Contribute


Are you tired of mundane planning sessions? It's time to get the party started with confetti.dev! Confetti brings a burst of color and excitement to your fibonacci process. Whether you're working with a large or small team, or just looking for a more engaging way to plan projects, confetti has got you covered. So why just estimate when you can celebrimate?

πŸŽ‰ Features

  • 🎨 Colorful - Confetti will rain down when all estimates agree.
  • πŸ“ˆ Realtime - See your team's estimates update in realtime.
  • πŸ“ Collaborative - Share your session with your whole team, small or large.
  • πŸ“Š Estimation - Confetti supports currently fibonacci estimates, more coming soon!
  • πŸ”“ Anonymous - No need to create an account. Just enter a username, and you're ready to go.
  • πŸ”’ Secure - Login with your favorite SSO provider. When logged in, your profile image will be shown in the session.
  • πŸ“¦ Open-source - Confetti is free and open-source.

πŸš€ Tech Stack

πŸ‘¨β€πŸš€ Getting Started

🚧 You will need Nodejs +16 (LTS recommended) installed.

  1. Fork this project:
  1. Clone the repository:
git clone [email protected]:YOU_USER/confetti.git
  1. Install dependencies:
npm install
  1. Create a .env file with the following content:

🚧 The environment variables must match the following schema.

# Next Auth Secrets
NODE_ENV=production
NEXTAUTH_SECRET=
NEXTAUTH_URL=http://localhost:3000

# OAuth secrets:
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

# Next Auth config:
NEXTAUTH_SECRET=
NEXTAUTH_URL=

# Database URLs:
DATABASE_URL=
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
  1. Ready πŸ₯³, now run:
# Create database migrations
npx prisma db push

# Run the project:
npm run dev