---

📌 Overview

Project OS is a cutting-edge Chrome New Tab Extension built with React 19, Vite, and Tailwind CSS v4. It replaces your standard blank new tab with an interactive, fully modular productivity dashboard — designed for developers, students, power users, and builders who live in the browser.

A companion landing website (web/) built with GSAP, Lenis smooth scroll, and a liquid-glass UI effect showcases the extension.

🔒 Local-first. Your data is stored on your device. Optional features, including activity sources, weather, and radio, contact external services. Cloud sync is in beta; new Google sign-ins are currently unavailable.

---

✨ Features

🎨 Multi-Theme Engine Default Glass, Cyberpunk 2077, Manga Style, and CLI Terminal Retro, Brutal, Painting, and Windows XP (beta) Customize colors, wallpaper, and typography in Settings	🧱 Drag & Drop Grid Physics-based drag & drop via @dnd-kit Dashboard Grid — multi-widget layout Hero View — distraction-free focus mode Widget toggle on/off on demand
⏰ Smart Clock & Greeting Real-time 12/24hr display Personalized dynamic greeting Live date, optional seconds ticker Theme-adaptive fonts & colors	🎯 Pomodoro Focus Timer Choose focus durations from 5 to 60 minutes Set up focus and rest cycles for longer work sessions Optional end-of-session sounds, including custom audio Daily focus tracking and analytics
🟩 Activity Matrix Contribution heatmaps for GitHub, Codeforces, and LeetCode Local caching reduces repeated requests See contribution totals and streaks	🎵 Ambient Audio Player Lofi radio stations (Zeno.fm, FluxFM, Laut.fm) Spotify quick access Volume control & custom stream URLs
📅 Time-Boxing Planner Create multiple routines and assign them to weekdays Ask for a routine each day or select it automatically Task blocks, subtask checklists, and streak tracking Daily rollover at 00:00 UTC	💧 Hydration Tracker Interactive water intake monitor Log water intake and track progress toward your goal Configurable reminder settings
🧭 Shortcuts Quick-launch shortcuts and custom icons Organize important tabs into groups	💾 Backup & Restore Export and restore a local JSON backup Move supported settings and productivity data between devices Cloud sync is in beta; new sign-ins are coming soon

🏝️ Dynamic Island & distraction warning

See your current task and focus timer while browsing. Configure work and distraction sites in Settings; during a focus session, listed distraction sites show a warning that you can dismiss.

📊 Analytics

Review locally stored focus time, completed sessions and tasks, water intake, time blocks, and site activity over time. Daily history starts when analytics is available; earlier activity may not be included.

---

🛠️ Tech Stack

Layer	Technology
Extension Framework	React 19 + Vite 7
Styling	Tailwind CSS v4 + Vanilla CSS Theme Engines
Drag & Drop	@dnd-kit/core + @dnd-kit/utilities
Activity Graph	react-activity-calendar
Icons	Remix Icon (remixicon)
Extension API	Chrome Manifest V3 (chrome.storage.local)
Landing Site	GSAP 3 + Lenis smooth scroll
Build Tool	Vite 7 (extension) · Vite 8 (web)

---

🏗️ Project Structure

Project-OS/
├── Frontend/                    # Browser extension
│   ├── public/                  # Manifest, content scripts, fonts and assets
│   ├── src/
│   │   ├── components/          # Dashboard, settings, analytics and widgets
│   │   ├── themes/              # Theme registry and styles
│   │   └── utils/               # Storage, timer, analytics and sync helpers
│   └── supabase/                # Cloud sync database setup
├── web/                         # Companion landing website
├── CONTRIBUTING.md
└── LICENSE

---

🚀 Quick Start

Prerequisites

• Node.js 22.12+ (required by the current dependencies)
• Google Chrome, Brave, Edge, Arc, or any Chromium-based browser
• The manifest includes Firefox settings; browser-specific behavior may vary

---

🔌 Option A — Load as Chrome Extension

1. Clone the repository

git clone https://github.com/rahul3rj/Project-OS.git
cd Project-OS

2. Install dependencies & build

cd Frontend
npm install
npm run build

3. Load into Chrome

1. Open chrome://extensions in your browser
2. Enable Developer mode (top-right toggle)
3. Click Load unpacked
4. Select the Frontend/dist folder

4. Open a new tab and experience Project OS! 🎉

---

💻 Option B — Development mode (UI-only)

cd Frontend
npm install
npm run dev

⚠️ The new-tab override requires the built extension. npm run dev is for fast UI iteration.

---

♻️ Rebuild after code changes

cd Frontend
npm run build

Then open chrome://extensions → click the Reload 🔄 icon on Project OS.

---

🌐 Run the Landing Website locally

cd web
npm install
npm run dev

---

🔐 Permissions & Privacy

The extension requests these browser permissions:

"permissions": ["identity", "storage", "unlimitedStorage"]

Permission	Why it's needed
storage / unlimitedStorage	Saves settings and productivity data on your device
identity	Supports the Google sign-in flow for the cloud sync beta

The Dynamic Island also runs on permitted websites to show your focus status and distraction warnings. Features such as radio streaming, weather, and activity sources connect to external services. Cloud sync, when available and enabled, sends supported data to the configured Supabase project; wallpapers remain on the device.

---

⭐ Star History

---

🤝 Contributing

Ideas, feedback, and code contributions are welcome! 💙

Read our full Contributing Guide →

You can report bugs, propose features, or fork the repository to submit a pull request. See the contribution guide for the terms that apply to contributions.

---

👥 Contributors

Thanks goes to these wonderful people 💙

Made with contrib.rocks

---

---

❓ FAQ

Is Project OS free?

Starting with v2.1.0, Project OS is free for personal, educational, research, and other non-commercial use under the [Project OS Personal Use License](./LICENSE). Other uses may require permission; earlier MIT-licensed material retains its applicable rights.

Does it collect any data?

Settings and productivity data are stored locally by default. Features such as weather, activity sources, and radio contact external services. Optional cloud sync is in beta; new sign-ins are currently unavailable.

Can I use it on Firefox or Edge?

Edge and other Chromium-based browsers can load the extension. The manifest also includes Firefox settings, but browser-specific features may behave differently.

How do I back up my configuration?

Go to Settings → Backup & reset to export a JSON backup or restore one. Cloud sync is in beta and new sign-ins are currently unavailable.

Can I contribute a new widget?

Absolutely! See the Contributing Guide for how to propose and build new widgets.

---

📜 License

Starting with v2.1.0, Project OS releases are offered under the Project OS Personal Use License. Earlier releases were made available under MIT; rights already granted for that material continue even when it appears in a later release. See LICENSE for the full terms and the original MIT notice.

---