This repository holds the data and server source code for the Let's Block It project. Please check out the project's about page and contributing guidelines.
- Go to letsblock.it, create an account and curate your personal filter list based on our filter templates. A personal URL will be generated for you to add to your uBlock Origin lists.
- Alternatively, you can maintain your filter parameters in a YAML file, and use the local render CLI to generate your personal filter list. You will still need to host it on a web server for it to be retrievable by uBlock Origin.
- Self-hosting of the letsblock.it server is currently not officially supported, as the database schema is evolving quickly. Don't hesitate to open an issue to discuss this if you'd be interested.
Here are the most important folders, check their README.md file for specific documentation:
- Filter templates are stored in data/filters/
- The local render command is in cmd/render/
- The letsblock.it server backend is in cmd/server/, it depends on golang backend code from src/ and handlebars page templates from data/pages/
- The letsblock.it frontend assets are defined in src/assets/ and pre-compiled in data/assets/dist/
- Development scripts are in scripts/
Don't hesitate to open issues on this repository, using the following templates: