Personal Dashboard

A modern, customizable browser homepage for organizing and accessing your favorite bookmarks with style.

🔗 Application URL: http://localhost:56480

Features

• 📁 Organized Categories - Group bookmarks by customizable categories with emoji icons
• 🎨 Modern UI - Beautiful gradient effects, smooth animations, and dark mode support
• 🔍 Search - Quickly find bookmarks across all categories
• 📊 Click Tracking - Monitor which bookmarks you use most
• 🌤️ Weather Widget - Built-in weather display (OpenWeather API integration)
• 🐳 Docker Ready - Easy deployment with Docker Compose
• 📱 Responsive - Works great on desktop and mobile devices

Tech Stack

• Frontend: React 18 + TypeScript + Vite
• Styling: Tailwind CSS + shadcn/ui components
• Backend: Express.js + TypeScript
• Database: PostgreSQL with Drizzle ORM
• Containerization: Docker + Docker Compose

📚 Documentation

• Docker Quick Start - Get running in 3 minutes
• Docker Setup Guide - Comprehensive Docker documentation

Quick Start

Using Docker (Recommended)

1. Clone the repository:

git clone <your-repo-url>
cd home-dashboard

2. Create a .env file:

DATABASE_URL=postgresql://dashboard_user:dashboard_pass@localhost:56481/personal_dashboard
OPENWEATHER_API_KEY=your_api_key_here  # Optional
NODE_ENV=development

3. Build and start the containers:

docker compose up -d --build

4. (Optional) Re-run database migrations manually:

docker compose exec app npm run db:push

The container automatically runs npm run db:push on boot, so this manual step is only needed when you want to inspect the migration output yourself.

5. Open http://localhost:56480 in your browser

Manual Setup

1. Install dependencies:

npm install

2. Set up PostgreSQL database and update .env

3. Run database migrations:

npm run db:push

4. Start development server:

npm run dev

Usage

1. Add Categories: Click "Add Category" to create bookmark groups with custom emojis
2. Add Bookmarks: Click the "+" button to add bookmarks to any category
3. Search: Use the search bar to find bookmarks across all categories
4. Organize: Create subcategories for better organization
5. Track Usage: Click counts help you see your most-used bookmarks

Development

• npm run dev - Start development server
• npm run build - Build for production
• npm run check - TypeScript type checking
• npm run db:push - Apply database schema changes

Environment Variables

• DATABASE_URL - PostgreSQL connection string (required)
• OPENWEATHER_API_KEY - OpenWeather API key for weather widget (optional)

Docker Configuration

The project includes:

• docker-compose.yml - Full stack configuration with PostgreSQL
• Dockerfile - Production build
• Dockerfile.dev - Development with hot reload

Contributing

Feel free to open issues or submit pull requests for improvements!

License

MIT License - feel free to use this project for your personal dashboard!