Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaziridwan/poof
A majestic site blocker, does some blocking, and more
https://github.com/kaziridwan/poof
Last synced: 5 days ago
JSON representation
A majestic site blocker, does some blocking, and more
- Host: GitHub
- URL: https://github.com/kaziridwan/poof
- Owner: kaziridwan
- Created: 2023-10-11T02:06:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-11T04:25:12.000Z (over 1 year ago)
- Last Synced: 2024-11-20T07:41:58.512Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Poof
Poof is a majestic site blocker and focus enhancer.
Currently available as chrome extension.
It mainly does site blocking, but much in depth, including features like
1. Conditional routing based on
1. route path
2. specific pages
2. Elegant block screen
3. Deep level Usage limits
1. usage limit per session
2. usage limit every day/ week/ month
4. Scheduled block rules***
## Product vision
A seamless way to enhance screentime across all devices.
# Development workflow
This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
## Getting Started
First, run the development server:
```bash
pnpm dev
# or
npm run dev
```
Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
For further guidance, [visit our Documentation](https://docs.plasmo.com/)
## Making production build
Run the following:
```bash
pnpm build
# or
npm run build
```
This should create a production bundle for your extension, ready to be zipped and published to the stores.
## Submit to the webstores
The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!