Skip to content

alvin-dennis/DropaLink

Repository files navigation

DropaLink

A modern, minimal link-sharing platform for private, one-time, and expiring links — giving you complete control over how, when, and who views your content.

🚀 Quick Start

Prerequisites

  • Node.js 18.17+
  • bun 8.0+ (Install)

Setup

# Clone repository
git clone https://github.com/alvin-dennis/DropaLink.git
cd DropaLink

# Install dependencies
bun install

# Configure environment
cp .env.example .env

# Start development server
bun dev

Open http://localhost:3000 in your browser.

📦 Available Commands

Development

# Start development server with hot reload
bun dev

Building & Deployment

# Create production build
bun build

# Start production server
bun start

# Build and start
bun build && bun start

Code Quality

# Run Biome linter
bun lint

# Fix linting issues automatically
bun lint:fix

# Format code with Biome
bun format

# Run all checks
bun validate

Type Checking

# Check TypeScript types
bun typecheck

# Alias
bun type-check

Maintenance

# Clean build artifacts
bun clean

# Install git hooks
bun prepare

# Install dependencies
bun install

⚙️ Configuration

Environment Variables

Create .env.local in project root:

NODE_ENV=development
NEXT_PUBLIC_SUPABASE_URL=your-project-url
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=your-publishable-or-anon-key

👨‍💻 Development

Quality Checks

Before Committing

# Run full validation
bun validate

# Fix auto-fixable issues
bun lint:fix
bun format

# Type check
bun typecheck

Git Hooks (Husky)

  • Pre-commit: Runs linting on changed files
  • Commit-msg: Validates conventional commit format

Commit Message Format

feat: add new feature
fix: fix a bug
docs: update documentation
style: format code
refactor: refactor code structure
perf: improve performance
test: add tests
chore: update dependencies

🤝 Contributing

Workflow

  1. Fork repository
  2. Create feature branch: git checkout -b feat/amazing-feature
  3. Make changes following code style
  4. Run bun validate
  5. Commit: git commit -m "feat: add amazing feature"
  6. Push: git push origin feat/amazing-feature
  7. Create Pull Request

Before Submitting

# Validate everything
bun validate

# Fix issues
bun lint:fix
bun format

# Type check
bun typecheck

# Build test
bun build

About

A modern, minimal link-sharing platform for private, one-time, and expiring links — giving you complete control over how, when, and who views your content.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors