Merge pull request #11 from Roystbeef/terragon/add-readme

Author: Roystbeef

README.md

@@ -0,0 +1,120 @@
+# Isle of Tortuga 🐕
+
+A delightful interactive website showcasing Tortie, a charismatic chihuahua-rat terrier mix with a big personality in a small, brown, blanket-burrowing body.
+
+## ✨ Features
+
+- **Animated Hero Section** - Welcome visitors with Tortie's adorable profile photo and bouncing animations
+- **Personality Cards** - Interactive cards highlighting Tortie's unique traits and quirks
+- **Photo Gallery** - A beautiful showcase of Tortie's most memorable moments
+- **Fun Facts** - Discover interesting tidbits about this rare pupper
+- **Animated Paw Prints** - Floating paw print animations throughout the site
+- **Responsive Design** - Optimized experience across desktop and mobile devices
+- **Smooth Animations** - Powered by Framer Motion for delightful user interactions
+
+## 🛠️ Tech Stack
+
+- **React 18** - Modern React with hooks and functional components
+- **TypeScript** - Type-safe development
+- **Vite** - Fast build tool and dev server
+- **Tailwind CSS** - Utility-first CSS framework
+- **Framer Motion** - Smooth animations and transitions
+- **Radix UI** - Accessible component primitives
+- **Lucide React** - Beautiful icon library
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Node.js (v16 or higher)
+- npm or yarn
+
+### Installation
+
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd terragon-labs-site
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Start the development server:
+```bash
+npm run dev
+```
+
+4. Open your browser and visit `http://localhost:5173`
+
+## 📜 Available Scripts
+
+- `npm run dev` - Start development server
+- `npm run build` - Build for production
+- `npm run preview` - Preview production build
+- `npm run lint` - Run ESLint
+- `npm run deploy` - Deploy to GitHub Pages
+
+## 🎨 Project Structure
+
+```
+├── components/
+│   ├── Hero.tsx           # Main hero section with Tortie's profile
+│   ├── PersonalityCards.tsx # Interactive personality trait cards
+│   ├── PhotoGallery.tsx   # Image gallery component
+│   ├── FunFacts.tsx       # Fun facts section
+│   ├── Footer.tsx         # Site footer
+│   ├── PawPrints.tsx      # Animated paw print decorations
+│   ├── figma/
+│   │   └── ImageWithFallback.tsx # Image component with fallback
+│   └── ui/                # Reusable UI components
+├── public/
+│   └── images/            # Static images of Tortie
+├── styles/
+│   └── globals.css        # Global styles and Tailwind imports
+└── guidelines/
+    └── Guidelines.md      # Development guidelines
+```
+
+## 🎯 Key Components
+
+- **Hero**: Eye-catching introduction with animated profile photo
+- **PersonalityCards**: Showcases Tortie's unique traits with smooth hover effects  
+- **PhotoGallery**: Responsive grid of Tortie's photos with smooth transitions
+- **FunFacts**: Interesting statistics and facts about Tortie
+- **PawPrints**: Decorative floating paw print animations
+
+## 🌟 Special Features
+
+- **Mobile-Responsive**: Optimized layouts for all screen sizes
+- **Accessibility**: Built with Radix UI primitives for screen reader support
+- **Performance**: Optimized with Vite's fast bundling and code splitting
+- **Animations**: Delightful micro-interactions powered by Framer Motion
+
+## 🚀 Deployment
+
+The site is configured for deployment to GitHub Pages:
+
+```bash
+npm run deploy
+```
+
+This will build the project and deploy it to the `gh-pages` branch.
+
+## 🤝 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 private and belongs to Terragon Labs.
+
+---
+
+Made with ❤️ for Tortie, the goodest rare pupper