Skip to content

MaheshR03/caffiend

Repository files navigation

☕ Caffiend

Caffiend is a modern, responsive coffee tracking application that helps users monitor their daily caffeine intake with intuitive data visualization and seamless user experience.

🌟 Features

  • Real-time Coffee Tracking: Log your coffee consumption with timestamp precision
  • Interactive Dashboard: Visual statistics and consumption patterns
  • User Authentication: Secure login and personalized data management
  • Responsive Design: Optimized for desktop and mobile devices
  • Firebase Integration: Cloud-based data storage and synchronization
  • Modern UI: Clean, intuitive interface built with FantaCSS

🚀 Live Demo

Experience the application live: https://caffiend-coffeetracker.vercel.app/

🛠️ Technology Stack

  • Frontend: React 18.3.1, Vite
  • Styling: FantaCSS, CSS3
  • Backend: Firebase (Authentication, Firestore Database)
  • Deployment: Vercel
  • Build Tools: Vite, ESLint

📷 Screenshots

Dashboard Overview

Caffiend Dashboard - Coffee tracking interface with statistics and consumption history

Coffee Logging Interface

Coffee logging form with time tracking and consumption details

🚀 Getting Started

Prerequisites

  • Node.js (version 16 or higher)
  • npm or yarn package manager
  • Firebase account for backend services

Installation

  1. Clone the repository

    git clone https://github.com/MaheshR03/caffiend.git
    cd caffiend
  2. Install dependencies

    npm install
  3. Configure Firebase

    • Create a Firebase project at Firebase Console
    • Enable Authentication and Firestore Database
    • Copy your Firebase configuration to firebase.js
  4. Start the development server

    npm run dev
  5. Build for production

    npm run build

📁 Project Structure

caffiend/
├── public/                 # Static assets
├── src/
│   ├── components/        # React components
│   │   ├── Authentication.jsx
│   │   ├── CoffeeForm.jsx
│   │   ├── Hero.jsx
│   │   ├── History.jsx
│   │   ├── Layout.jsx
│   │   ├── Modal.jsx
│   │   └── Stats.jsx
│   ├── context/          # React context providers
│   │   └── AuthContext.jsx
│   ├── utils/            # Utility functions
│   ├── App.jsx           # Main application component
│   └── main.jsx          # Application entry point
├── firebase.js           # Firebase configuration
└── package.json          # Project dependencies

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the project
  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

About

A coffee tracking app with ReactJS, FantaCSS and Firebase

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published