https://github.com/matthewdlr/digital-awareness

Unlearn bad browsing habits and become more aware of your digital life.
https://github.com/matthewdlr/digital-awareness

chrome-extension digital-wellbeing productivity

Last synced: over 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/matthewdlr/digital-awareness
• Owner: MatthewDlr
• License: other
• Created: 2023-10-28T09:04:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T07:10:07.000Z (over 2 years ago)
• Last Synced: 2024-04-13T21:38:56.297Z (over 2 years ago)
• Topics: chrome-extension, digital-wellbeing, productivity
• Language: HTML
• Homepage: https://chromewebstore.google.com/detail/digital-awareness/eciijpgppecgdjfemignfbgnnhnmnkia?hl=en
• Size: 3.95 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          


  



Digital Awareness

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




  

    

  






## Features

✅ Prevent yourself from opening distracting websites mindlessly 


✅ Automatically adapts based on your usage 


✅ 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 


## Development Setup

[![Deployment](https://github.com/MatthewDlr/Digital-Awareness/actions/workflows/deployment.yml/badge.svg)](https://github.com/MatthewDlr/Digital-Awareness/actions/workflows/deployment.yml)

[![CodeQL](https://github.com/MatthewDlr/Digital-Awareness/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/MatthewDlr/Digital-Awareness/actions/workflows/github-code-scanning/codeql)

### Tech Stack

![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white)

![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)

![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![Webpack](https://img.shields.io/badge/Webpack-8DD6F9?style=for-the-badge&logo=Webpack&logoColor=white)

### Installation

Run `pnpm install` to get started and install all dependencies.

If you do not have pnpm installed, run `npm install -g pnpm`.

### Develop

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 serve`and `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.

### Dependencies

![PNPM](https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge&logo=pnpm&logoColor=f69220) 


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


### Lint

![ESlint](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)

![Prettier](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E) 


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.

### Tests

Currently, tests are not implemented.

### Build

Run `pnpm build` to build the project for production.

The build artifacts will be stored in the `dist/` directory.

## Contributing

⭐ Star us, it motivates a lot!

### Issues

If you find a bug or have a feature request, please open an issue on the [issues tracker](https://github.com/MatthewDlr/Digital-Awareness/issues).

### Pull Requests

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

## Credits

Made with ❤️ by Matthieu Delarue, 2023. 


**Inspiration sources** 


Consistency, a Chrome extension made by [@patresk](https://github.com/patresk). 


Digital Wellbeing, an experiment introduced in Android 9 by Google. 


## License

This project is licensed under Commons Clause License. 


Learn more at https://commonsclause.com.