Background Sounds - Chrome Extension

About

A simple Chrome extension timer for tracking time and focus sessions. Built with React, TypeScript, and Vite.

Technologies

• @vitejs/plugin-react-swc uses SWC for Fast Refresh

Installation

Development Setup

1. Fork the repository
2. Clone the project
3. Navigate to cd Background-Sounds
4. Install dependencies with

npm install

5. Build the extension

npm run build

Loading the Extension in Chrome

1. Open Chrome and navigate to chrome://extensions
2. Enable "Developer mode" using the toggle in the top-right corner
3. Click "Load unpacked"
4. Select the dist/ folder from the project directory
5. The extension icon should appear in your Chrome toolbar

Using the Extension

• Click the extension icon in your Chrome toolbar to open the timer popup
• Use Start/Stop buttons to control the timer
• Use Clear button to reset the timer

Development

Run the development server:

npm run dev

Note: For Chrome extension development, you'll need to rebuild and reload the extension in Chrome after making changes.

Contributing

• Thank you for considering to contribute
• Feel free to submit feature requests, UI updates, bugs as issues.
• Checkout Contribution Guidelines for more information.
• Have a feature request? Feel free to create a issue for it.

Publishing to Chrome Web Store (Optional)

To publish this extension to the Chrome Web Store:

1. Create a developer account at Chrome Web Store Developer Dashboard
2. Build the extension: npm run build
3. Zip the dist/ folder
4. Upload the zip file to the Chrome Web Store
5. Fill in the required store listing information
6. Submit for review

Thanks to all Contributors 💪

Thanks a lot for contributing to Background Sounds.

Inspiration

https://github.com/Utkarshn10/Focusly

Stats