🔗 Blinky

Enhance Your Link Management

Features • Quick Start • Installation • API • Tech Stack

---

✨ Features

• 🚀 Fast & Modern - Built with Next.js 15 and React 19
• 🔐 Secure Authentication - OAuth with GitHub and Google
• 📊 User Dashboard - Manage all your short links in one place
• 🎨 Beautiful UI - Clean, responsive design with Tailwind CSS
• 🔧 Type Safe - Full TypeScript support
• 📱 Mobile Ready - Responsive design for all devices
• 🛡️ Secure - Built-in authentication and authorization

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm, yarn, or pnpm

Installation

# Clone the repository
git clone https://github.com/yourusername/blinky.git
cd blinky

# Install dependencies
npm install
# or
yarn install
# or
pnpm install

Environment Setup

Create a .env file in the root directory:

# Authentication
AUTH_SECRET="your-secret-key"
AUTH_TRUST_HOST=true

# GitHub OAuth (Optional)
AUTH_GITHUB_ID=your-github-client-id
AUTH_GITHUB_SECRET=your-github-client-secret

# Google OAuth (Optional)
AUTH_GOOGLE_ID=your-google-client-id
AUTH_GOOGLE_SECRET=your-google-client-secret

# Database
DATABASE_URL="file:./data/dev.db"

Database Setup

# Generate Prisma client
npx prisma generate

# Run database migrations
npm run db:migrate

# (Optional) Open Prisma Studio
npm run db:studio

Development

# Start development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

# Run linting
npm run lint

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

📋 Available Scripts

Command	Description
npm run dev	Start development server with Turbopack
npm run build	Build the application for production
npm run start	Start the production server
npm run lint	Run ESLint
npm run db:migrate	Run Prisma migrations
npm run db:studio	Open Prisma Studio
npm run db:reset	Reset and migrate database

🛠️ Tech Stack

Core Framework

• Next.js 15 - React framework with App Router
• React 19 - UI library
• TypeScript 5 - Type safety

Styling & UI

• Tailwind CSS 4 - Utility-first CSS framework
• Radix UI - Unstyled, accessible components
• Lucide React - Beautiful icons
• class-variance-authority - Component variants
• Shadcn - UI Components

Database & ORM

• Prisma 6 - Next-generation ORM
• SQLite - Lightweight database (development)

Authentication

• NextAuth.js 5 - Authentication for Next.js
• Prisma Adapter - Database adapter

Utilities

• Zod - TypeScript-first schema validation
• clsx - Conditional className utility

🤝 Contributing

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

📝 License

This project is open source. Feel free to use it for your own projects!

🙏 Acknowledgments

• Built with love using modern web technologies
• Inspired by the need for simple, elegant link management
• Thanks to the open source community for the amazing tools