Skip to content

README.md

Latest commit

 

History

History
180 lines (116 loc) · 4.8 KB

README.md

File metadata and controls

180 lines (116 loc) · 4.8 KB

Got it ✅ — here’s your Focus Clock README rewritten in the same style/structure as your Waldo Finder project:

Focus Clock Icon Focus Clock ⏳

Focus Clock is a modern, cross-platform productivity timer app that helps you stay focused with customizable timers and Pomodoro sessions. Built with Tauri, SolidJS, and TypeScript for speed, simplicity, and local performance.

This app was built in just 2 hours and designed specifically for display on a second monitor to keep you focused without cluttering your main screen.

Tech Used 🧑‍💻

Tauri SolidJS TypeScript TailwindCSS Rust Vite

Core Features ⚡

  • 🍅 Pomodoro Timer: Classic Pomodoro technique with customizable work/break intervals.

  • ⏲️ Custom Timers: Create and manage multiple timers for different tasks.

  • 🎨 Modern UI: Clean, responsive interface powered by SolidJS + TailwindCSS.

  • 💻 Cross-Platform: Works on Windows, macOS, and Linux with Tauri backend.

  • 💾 Persistent Settings: Your preferences and timer configurations are saved locally.

Screenshots 📸


Home Screen

Home: Overview of your timers and recent activity.


Navigation Menu

Navigation Menu: Quick minimal navigation menu without distractions.


Pomodoro Screen

Pomodoro: Start sessions with configurable intervals.


Timer Gallery

Timer Gallery: Manage your custom timers.


Settings Screen

Pomodoro Settings: Here you can save your pomodoro preferences.


Settings Screen

About: About page that describes the project.

Project Structure 📂

src/
├── components/       # Reusable UI components
├── routes/           # Pages and routing
├── hooks/            # Custom hooks for timer logic
├── config/           # App configuration
├── types/            # TypeScript types
└── style/            # TailwindCSS styles

src-tauri/            # Tauri backend (Rust)
├── src/              # Rust source code
└── tauri.conf.json   # Tauri config

Setup and Development 🛠️

  1. Prerequisites:

    • Node.js (v16+)
    • pnpm
    • Rust (latest stable)

  2. Clone and install dependencies:

    git clone <repository-url>
cd focus-clock
pnpm install

  3. Run in development mode:

    pnpm start

  4. Build for production:

    pnpm build
pnpm tauri build

    The app will be available in src-tauri/target/release/.

Recommended IDE Setup 💻

Contributing 👥

Contributions are welcome! If you want to fix bugs, add features, or improve the codebase:

  1. Fork the repo
  2. Create a feature branch (git checkout -b feature/MyFeature)
  3. Make your changes and test
  4. Push and open a Pull Request

Roadmap 🗺️

Phase 1: Core Functionality

  • Pomodoro timer with intervals
  • Custom timers
  • Persistent settings

Phase 2: Enhanced Features

  • Stats and reports
  • Advanced theming
  • Cloud sync

License ⚖️

MIT License – see LICENSE file for details.

Contact 📬

Do you want me to also add fancy shields for features (like Pomodoro, timers, cross-platform) to make it match the “flashy” vibe of your old readme?