Santa's Sight

🎄 A comprehensive Christmas operations management dashboard

📖 Overview

Santa's Sight is a modern web application designed to help manage Christmas operations efficiently. It provides a suite of tools for tracking elves, reindeer, routes, and more, all within a festive and user-friendly interface.

🌟 Features

• Dashboard - Overview of all Christmas operations
• Elves Management - Track and manage elf activities
• Reindeer Tracking - Monitor reindeer health and readiness
• Route Planning - Optimize Santa's delivery routes
• Letters Management - Process children's Christmas letters
• Chill Zone - Relaxation area monitoring
• Children Database - Manage nice/naughty list
• Calories Tracker - Monitor Santa's cookie consumption

🚀 Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm or yarn

Installation

1. Clone the repository

git clone https://github.com/your-username/front-end.git
cd santas-sight

2. Install dependencies

npm install

3. Start the development server

npm run dev

🛠 Tech Stack

• Framework: React 18
• Routing: React Router v7
• State Management: React Query
• Styling: Tailwind CSS
• UI Components: Shadcn UI
• Maps: Leaflet
• Charts: Recharts
• Form Handling: React Hook Form
• Validation: Zod
• Build Tool: Vite

📚 Documentation

For detailed technical documentation and component specifications, please visit our Technical Documentation.

🏗 Project Structure

.
├── dist/                   # Production build files
├── public/                 # Static assets
├── src/                    # Source code
│   ├── components/
│   │   ├── global/        # Global components
│   │   │   ├── sideBar.jsx
│   │   │   ├── snowFlakeTop.jsx
│   │   │   └── toastContainer.jsx
│   │   └── ui/           # UI components
│   ├── pages/            # Page components
│   │   ├── dashboardPage.jsx
│   │   ├── elvesPage.jsx
│   │   ├── reindeerPage.jsx
│   │   ├── routesPage.jsx
│   │   ├── chillZone.jsx
│   │   ├── letters.jsx
│   │   └── childrenPage.jsx
│   ├── App.jsx           # Main App component
│   └── main.jsx         # Entry point
├── .DS_Store
├── .env                  # Environment variables
├── .eslintrc.js         # ESLint configuration
├── .gitignore           # Git ignore rules
├── README.md            # Project documentation
├── components.json      # Components configuration
├── index.html          # HTML entry point
├── jsconfig.json       # JavaScript configuration
├── package-lock.json   # Package lock file
├── package.json        # Project dependencies
├── postcss.config.js   # PostCSS configuration
├── tailwind.config.js  # Tailwind CSS configuration
└── vite.config.js      # Vite configuration

🔄 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

🤝 Contributing

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

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• All the hardworking elves who contributed to this project
• The reindeer for their patience during testing
• Santa for his project oversight

---

Made with ❤️ by Team 3 ED8