Skip to content

README.md

Latest commit

 

History

History
67 lines (49 loc) · 1.36 KB

README.md

File metadata and controls

67 lines (49 loc) · 1.36 KB

TimeFlow 🌱

A React application for tracking and visualizing energy usage patterns.

Quick Start 🚀

git clone https://github.com/TTMordred/TimeFlow.git
# Install dependencies
npm install
npm install vite --save-dev

# Start dev server
npm run dev

Tech Stack 💻

  • Framework: React + TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • UI Components: shadcn/ui
  • Backend: Supabase
  • Package Manager: npm/bun

Project Structure 📁

src/
├── components/     # Reusable UI components
├── hooks/         # Custom React hooks
├── integrations/  # External service integrations
├── layout/        # Layout components
├── lib/          # Utility functions
└── pages/        # Application pages

Main Features 🎯

  • User Authentication
  • Dashboard Analytics
  • Energy Usage Statistics
  • Achievement System
  • Leaderboard
  • Calendar Integration

Development 🛠️

Prerequisites

  • Node.js (LTS version)
  • npm or bun

Local Development

  1. Clone the repository
  2. Install dependencies: npm install npm install vite --save-dev
  3. Start the dev server: npm run dev
  4. Open http://localhost:5173

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build

Deployment 🌐