Skip to content

Stavin13/Idea-Vault

Repository files navigation

IdeaVault

Hacktoberfest 2024 Open Source Next.js Supabase

A modern full-stack idea sharing platform built with Next.js and Supabase.

🎉 Hacktoberfest 2024

We're participating in Hacktoberfest! Looking for contributors to help improve IdeaVault. Check out our Contributing Guide and look for issues labeled hacktoberfest or good-first-issue.

🚀 Quick Start

The main application is in the idea-vault/ directory.

cd idea-vault
npm install --legacy-peer-deps
npm run dev

Open http://localhost:3000 to view the application.

📁 Project Structure

idea-vault/               # Main Next.js application
├── app/                 # Next.js App Router pages
├── components/          # React components
├── hooks/              # Custom React hooks
├── lib/                # Utilities and configurations
├── database/           # Supabase database setup
└── README.md           # Detailed documentation

🛠 Tech Stack

  • Frontend: Next.js 15 + React 19 + TypeScript
  • Styling: Tailwind CSS v4 + Radix UI
  • Backend: Supabase (PostgreSQL + Auth + Real-time)
  • Authentication: Supabase Auth with email/password
  • Real-time: Supabase subscriptions

📖 Documentation

For detailed setup instructions, features, and development guide, see:

📚 Full Documentation →

🔧 Environment Setup

  1. Copy environment file:

    cd idea-vault
    cp .env.local.example .env.local
  2. Add your Supabase credentials to .env.local (never commit this file!)

  3. Set up the database using files in idea-vault/database/

🔒 Security

  • Never commit real API keys or credentials
  • Use .env.local for your actual credentials (already in .gitignore)
  • See SECURITY.md for detailed security guidelines
  • Report security issues privately to maintainers

🚀 Features

  • ✨ Modern Next.js 15 with App Router
  • 🔐 Complete authentication system
  • 📊 Real-time voting and updates
  • 🎨 Beautiful UI with dark/light themes
  • 📱 Fully responsive design
  • ⚡ Optimized performance

🌐 Deployment

Quick Deploy to Vercel

Deploy with Vercel

Manual Deployment

  1. Fork this repository
  2. Connect to Vercel:
    • Go to vercel.com and sign in
    • Click "New Project" and import your fork
    • Set Root Directory to idea-vault
    • Set Install Command to npm install --legacy-peer-deps
  3. Add Environment Variables:
    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
    
  4. Deploy!

See VERCEL_DEPLOYMENT_GUIDE.md for detailed troubleshooting.

📄 License

MIT License

About

Full-stack open-source idea sharing platform

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published