Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 1.92 KB

README.md

File metadata and controls

86 lines (62 loc) · 1.92 KB

PomoFly

PomoFly is a productivity application that combines the Pomodoro Technique with task management to help users boost their productivity and manage their time effectively.

Features

  • Pomodoro timer
  • Task management
  • User authentication
  • Real-time data synchronization
  • Responsive design for desktop and mobile

Technologies Used

  • Next.js
  • React
  • Firebase (Authentication, Firestore, Hosting)
  • CSS (or specify if you're using a CSS framework)

Getting Started

Prerequisites

  • Node.js (v14 or later)
  • npm or yarn
  • Firebase account

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/pomofly.git
    cd pomofly
    
  2. Install dependencies:

    npm install
    
  3. Set up environment variables: Create a .env.local file in the root directory and add your Firebase configuration:

    NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
    NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
    NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id
    
  4. Run the development server:

    npm run dev
    
  5. Open http://localhost:3000 in your browser to see the application.

Deployment

This project is set up for deployment on Firebase Hosting. To deploy:

  1. Build the project:

    npm run build
    
  2. Deploy to Firebase:

    npm run deploy
    

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Acknowledgements