Skip to content

Latest commit

 

History

History
104 lines (80 loc) · 3.58 KB

README.md

File metadata and controls

104 lines (80 loc) · 3.58 KB
Raw

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