Get a Break

Get a Break is an Electron-based desktop application designed to help users maintain a healthy work-life balance by reminding them to take regular breaks during their work sessions.

Features

• Customizable work session durations
• Automatic break reminders
• Configurable break durations
• Long break support after multiple work sessions
• Toolbar timer display
• Dashboard for session tracking
• Pause and resume session functionality
• Option to skip breaks or take them early
• Launch at login capability
• Cross-platform support (macOS, Windows, Linux)

Installation

To install and run the application locally:

1. Clone the repository:

   git clone https://github.com/holaChaitanya/nerdy-cheese.git
   cd nerdy-cheese
   

2. Install dependencies:

   npm install
   

3. Start the application in development mode:

   npm start
   

Technology Stack

• Electron
• React
• TypeScript
• Webpack
• Tailwind CSS
• Electron Store (for persistent storage)

Project Structure

The project follows a typical Electron + React structure:

• src/main: Contains the main process code
• src/renderer: Contains the renderer process code (React components)
• .erb: Contains build and configuration scripts

Configuration

The application uses Electron Store for persistent configuration. Key configuration options can be found in:

Contributing

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

License

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

Author

Chaitanya Aaditya

• GitHub: @holaChaitanya
• Email: [email protected]

Acknowledgments

• This project was built using the Electron React Boilerplate
• Icons provided by Radix UI

---

For more information on using the application, please refer to the in-app settings and dashboard.