README.md

Remove low-quality content and useless nags, focus on what matters.

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.

How to use this project

There are three ways to use our filter templates:

1. 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.
2. Self-hosting of the letsblock.it server is now supported for experienced users, read the setup doc to get started.
3. 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.

Repository structure

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/

Opening issues

Don't hesitate to open issues on this repository, using the following templates:

• Improve / fix an existing filter template
• Suggest a new filter template
• Report a bug
• Other topics

Thanks to our contributors

Thanks goes to these wonderful people (emoji key):

Xavier Vello 🚧 🔣 💻	JohnyP36 🚧 🔣	Nomes77 🚧 🔣	quenhus 🔣	neonItem 🔣	xbc5 🔣	Markus Igeland 🔣
kiriya-aoi 🔣	Kristian Salonen 🔣	mailyspamy 🔣	Santiago Lo Coco 🔣	Webswonder 💵	Sigourney Juneau 🔣	Alexander ADAM 📣
3DWORX-SA 🤔	Dosenpfand 🔣	Joakim Hellsén 💵	Ben Hendel-Doying 💵	Daniel Cheang 🔣	leo1115 🤔	Mat Jones 🔣
Henrik Skott 💵	Danny Schmarsel 🔣	lightbulbmeow 🔣	tepozoa 🔣	Sam McLeod 🔣	vimode 🔣	hianick 🔣
Darylle Villanueva 🔣	Nicolas P. 🔣	woodiertexas 🔣	Mr. Bizzle 🔣	ItsProfesssional 🔣	eleve 💵	Veyndan Stuart 🔣
HyperCriSiS 🔣

Thanks to our corporate sponsors

	Thanks to Ory for powering the official instance's account management with Ory Network.
	Thanks to Jetbrains for providing free GoLand licenses.
	Thanks to Datadog for providing free monitoring for servers hosting the official instance.