Skip to content

A URL shortener web application built with Remix, featuring a clean UI, real-time analytics, and seamless user experience.

Notifications You must be signed in to change notification settings

RajNykDhulapkar/gotiny-app

Repository files navigation

GoTiny Frontend

A modern URL shortener web application built with Remix, featuring a clean UI, real-time analytics, and seamless user experience.

Features

  • Clean, modern UI built with ShadCN/UI components
  • Real-time URL shortening and management
  • User authentication and URL management
  • URL analytics and click tracking
  • QR code generation for shortened URLs
  • Light/dark theme support
  • Mobile-responsive design

Tech Stack

Quick Start

  1. Clone the repository:
git clone https://github.com/RajNykDhulapkar/gotiny-app.git
cd gotiny-app
  1. Install dependencies:
pnpm install
  1. Configure environment variables:
NODE_ENV=development
SESSION_SECRET=your-secret
SHORT_URL_SERVICE_URL=http://localhost:8080
  1. Start development server:
pnpm run dev

Project Structure

.
├── app/
│   ├── components/     # Reusable UI components
│   ├── lib/           # Utilities and helpers
│   ├── routes/        # Application routes
│   ├── sessions/      # Session management
│   └── tailwind.css   # Global styles
├── public/            # Static assets
└── components.json    # ShadcnUI configuration

Features Overview

URL Shortening

  • Quick URL shortening with custom slug option
  • QR code generation for shortened URLs
  • Link history and management

Analytics

  • Click tracking and analytics
  • Geographic distribution
  • Browser and device statistics
  • Referrer tracking

User Features

  • User authentication
  • Personal dashboard
  • URL management
  • Analytics exports

Docker Support

Build the image:

docker build -t gotiny-app .

Run the container:

docker run -d \
  -p 3000:3000 \
  -e NODE_ENV=production \
  -e SESSION_SECRET=your-secret \
  -e SHORT_URL_SERVICE_URL=http://api:8080 \
  gotiny-app

Development

# Start development server
pnpm run dev

# Type checking
pnpm run typecheck

# Build for production
pnpm run build

# Start production server
pnpm start

Styling

This project uses Tailwind CSS with ShadcnUI components. The theme can be customized in:

  • tailwind.config.ts - Tailwind configuration
  • app/tailwind.css - Global styles
  • components.json - ShadcnUI theme configuration

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Install dependencies (pnpm install)
  4. Make your changes
  5. Run tests and type checking
  6. Submit a pull request

Related Projects

License

MIT License

About

A URL shortener web application built with Remix, featuring a clean UI, real-time analytics, and seamless user experience.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published