Skip to content

StefanWin/estimation-corgi

Repository files navigation

Estimation Corgi 🐕

Properly estimate your tasks with the help of a corgi

A fun web app that provides random time estimates for your tasks, accompanied by adorable corgi images. Because sometimes you need a corgi to tell you how long something will take.

Features

  • 🎲 Random time estimates (1-40 hours)
  • 🐶 Rotating collection of cute corgi images
  • 💬 Community-suggested estimation messages
  • 🌓 Light/dark mode toggle
  • 📱 Fully responsive design
  • ✨ Modern UI with smooth animations

Tech Stack

  • Framework: Next.js 16 (App Router)
  • Language: TypeScript
  • Backend: Convex
  • Styling: CSS Modules
  • Deployment: Vercel
  • Fonts: Geist Sans & Geist Mono

Getting Started

Prerequisites

  • bun

Installation

  1. Clone the repository:
git clone https://github.com/StefanWin/estimation-corgi.git
cd estimation-corgi
  1. Install dependencies:
bun run install
  1. Copy env.example to .env Convex will setup its own env variables after you authenticate.

  2. Start Convex and Next dev servers:

bun run dev

Open http://localhost:3000 to see the app.

Project Structure

estimation-corgi/
├── src/
│   ├── app/              # Next.js app router pages
│   ├── components/       # React components
│   ├── constants.ts      # App constants (images, etc.)
│   └── util.ts          # Utility functions
├── convex/              # Convex backend functions
├── public/              # Static assets (corgi images)
└── package.json

Contributing

Contributions are welcome! Feel free to:

  • Submit new corgi images (with proper attribution)
  • Suggest new estimation messages
  • Report bugs or request features
  • Improve documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

  • Corgi images sourced from various contributors (see attributions on the /meta page)
  • Built with love by stefanwintergerst.com

Links

About

Properly estimate your tasks with the help of a corgi

Resources

License

Stars

Watchers

Forks

Contributors