matthewdlr / digital-awareness Goto Github PK

Unlearn bad browsing habits and become more aware of your digital life.

✅ Prevent yourself from opening distracting websites mindlessly
✅ Automatically adapts based on your usage with machine learning
✅ Get insights on your digital habits
✅ Add your own websites
✅ Customize with quotes, breathing exercises or your own goals
✅ Prevent doom scrolling
✅ Dark mode
✅ Absolutely free
✅ Compatible with any Chromium-based web browser

Run pnpm install to get started and install all dependencies. If you do not have pnpm installed, run npm install -g pnpm.

Run pnpm dev to start the development server. To test the extension, go to chrome://extensions/ and enable developer mode. Then click on Load unpacked and select the output folder

Please do not use angular cli commands like ng serveand ng build since it doesn't run the custom webpack configuration and custom flags, it results in missing files from the compilation output and unexpected behaviors across the extension.

Be aware that when the extension in running in development mode, it behaves differently ; all timers are much faster and won't adapt to your usage and, you'll also get much more logs in the page console. To avoid affecting the user experience, please limit your own logging to development mode using the isDevMode() function of Angular.

If you modify the manifest, or the .ts files at the root of the project, you will need to reload the extension to see your changes. For everything related to the angular app, you can simply reload the page.

Please, be cautious when adding new dependencies to the project.
If you need to add a new dependency, make sure it is really necessary and that it is well maintained.

If a dependency is creating conflicts, never use --force to add it anyway

This project relies on eslint and prettier to enforce a unified and clean code style.

Run pnpm lint to lint the project ; also a hook is setup to run the linter before each commit.
Please do not commit if the linter fails and do not disable the linter.

Currently, tests are not implemented.

Run pnpm build to build the project for production. The build artifacts will be stored in the dist/ directory.

⭐ Star us, it motivates a lot!

If you find a bug or have a feature request, please open an issue on the issues tracker.

Pull requests are welcome. Please make sure that your changes reflect the vision of the project.

Made with ❤️ by Matthieu Delarue, 2023.

Inspiration sources
Consistency, a Chrome extension made by @patresk.
Digital Wellbeing, an experiment introduced in Android 9 by Google.

This project is licensed under Commons Clause License.
Learn more at https://commonsclause.com.