DoudGaya/interlude

Abdulrahman Dauda

Abdulrahman Dauda

Interlude

Interlude Planner App is a productivity application built with Next.js and Firebase, designed to help desk-based workers plan their work with break intervals, which will enhance their productivity.

Features

User authentication: Sign up and login with email and password.
Create work plans: Users can create multiple work plans with customizable work minutes and break durations.
Delete work plans: Users have the option to delete their work plans.
Dark and Light Mode: Application will detect the system preference and also give users the ability to switch between light and dark mode
Countdown timer: The app includes a countdown timer that triggers an alarm when the work time elapses, indicating it's time for a break.

Technologies Used

Next.js: A React framework for server-side rendering and building web applications.
Firebase: A cloud-based platform for building web and mobile applications.
React: A JavaScript library for building user interfaces.
TailwindCSS: Styling the application.
Languages: TypeScript and Javscript

Installation

Clone the repository:
git clone https://github.com/DoudGaya/interlude.git
Navigate to the project directory
cd interlude
install the project
npm install
Set up Google Firebase
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_SENDER_ID> NEXT_PUBLIC_FIREBASE_APP_ID=<YOUR_APP_ID>
start a development server
npm run dev
Open your browser and visit http://localhost:3000 to see the app.

Usage

Sign up or log in using your email and password.
Create a new work plan by providing the work minutes and break duration.
Delete a work plan if needed.
Start a work plan to trigger the countdown timer.
When the work time elapses, an alarm will be triggered, indicating it's time for a break.
Repeat the process for other work plans as necessary.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please submit a pull request or open an issue in this repository.

License

Like this project

Posted Dec 16, 2023

Created for interlude and Codemonk Hackathon. Technologies Include Google Firebase, TailwindCSS, TypeScript, Next.js, Next Auth