|
| 1 | +# TaskTimer Browser Extension |
| 2 | + |
| 3 | +A modern, beautiful browser extension for tracking time spent on tasks with pause/resume functionality. Built with React, TypeScript, and Tailwind CSS. |
| 4 | + |
| 5 | + |
| 6 | +## Features |
| 7 | + |
| 8 | +- ⏱️ Simple and intuitive task time tracking |
| 9 | +- ⏸️ Pause and resume timer functionality |
| 10 | +- 📊 Task history with detailed time logs |
| 11 | +- 🎯 Background tracking even when popup is closed |
| 12 | +- 💾 Persistent storage across browser sessions |
| 13 | +- 🎨 Modern, responsive UI with Tailwind CSS |
| 14 | +- 🌙 Clean, minimalist design |
| 15 | + |
| 16 | +## Installation |
| 17 | + |
| 18 | +### Development |
| 19 | + |
| 20 | +1. Clone this repository |
| 21 | +2. Install dependencies: |
| 22 | +```bash |
| 23 | +npm install |
| 24 | +``` |
| 25 | +3. Start the development server: |
| 26 | +```bash |
| 27 | +npm run dev |
| 28 | +``` |
| 29 | + |
| 30 | +### Loading the Extension |
| 31 | + |
| 32 | +#### Chrome/Edge |
| 33 | +1. Build the extension: |
| 34 | +```bash |
| 35 | +npm run build:extension |
| 36 | +``` |
| 37 | +2. Open Chrome/Edge and navigate to `chrome://extensions` |
| 38 | +3. Enable "Developer mode" |
| 39 | +4. Click "Load unpacked" and select the `dist` folder |
| 40 | + |
| 41 | +#### Firefox |
| 42 | +1. Build the extension: |
| 43 | +```bash |
| 44 | +npm run build:extension |
| 45 | +``` |
| 46 | +2. Open Firefox and navigate to `about:debugging` |
| 47 | +3. Click "This Firefox" |
| 48 | +4. Click "Load Temporary Add-on" and select any file from the `dist` folder |
| 49 | + |
| 50 | +## Usage |
| 51 | + |
| 52 | +1. Click the extension icon in your browser toolbar |
| 53 | +2. Enter a task name and click "Start Timer" |
| 54 | +3. Use the pause/resume button to temporarily stop/continue timing |
| 55 | +4. Click "Stop Timer" when done to save the task |
| 56 | +5. View your task history in the "History" tab |
| 57 | + |
| 58 | +## Development |
| 59 | + |
| 60 | +### Project Structure |
| 61 | + |
| 62 | +``` |
| 63 | +├── src/ |
| 64 | +│ ├── components/ # React components |
| 65 | +│ ├── utils/ # Utility functions |
| 66 | +│ ├── types.ts # TypeScript types |
| 67 | +│ └── App.tsx # Main application |
| 68 | +├── public/ |
| 69 | +│ └── icons/ # Extension icons |
| 70 | +└── background.js # Service worker |
| 71 | +``` |
| 72 | + |
| 73 | +### Available Scripts |
| 74 | + |
| 75 | +- `npm run dev` - Start development server |
| 76 | +- `npm run build` - Build the extension |
| 77 | +- `npm run build:extension` - Build extension with icon conversion |
| 78 | +- `npm run lint` - Run ESLint |
| 79 | + |
| 80 | +## Technical Details |
| 81 | + |
| 82 | +- Built with React 18 and TypeScript |
| 83 | +- Uses Chrome Extension Storage API for persistence |
| 84 | +- Background service worker for timer management |
| 85 | +- Tailwind CSS for styling |
| 86 | +- Lucide React for icons |
| 87 | + |
| 88 | +## Contributing |
| 89 | + |
| 90 | +1. Fork the repository |
| 91 | +2. Create your feature branch (`git checkout -b feature/amazing-feature`) |
| 92 | +3. Commit your changes (`git commit -m 'Add amazing feature'`) |
| 93 | +4. Push to the branch (`git push origin feature/amazing-feature`) |
| 94 | +5. Open a Pull Request |
| 95 | + |
| 96 | +## License |
| 97 | + |
| 98 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 99 | + |
| 100 | +## Acknowledgments |
| 101 | + |
| 102 | +- [React](https://reactjs.org/) |
| 103 | +- [TypeScript](https://www.typescriptlang.org/) |
| 104 | +- [Tailwind CSS](https://tailwindcss.com/) |
| 105 | +- [Lucide Icons](https://lucide.dev/) |
| 106 | +- [Vite](https://vitejs.dev/) |
0 commit comments