Files

undergroundwires 3c3ec80525 Improve documentation for developing

Move existing documentation to `docs/development.md` to have simpler
`README.md` but more dedicated and extensive documentation for
development.

Improve existing documentation for different commands for the project.

Document VSCode recommendations in `extensions.json` file and add
exception in `.gitignore` to be able to add it to repository.

2022-01-26 08:14:25 +01:00

6.9 KiB

Raw Blame History

privacy.sexy

Enforce privacy & security best-practices on Windows and macOS, because privacy is sexy 🍑🍆

Get started

Online version at https://privacy.sexy
- 💡 No need to run any compiled software on your computer.
Alternatively download offline version for Windows, macOS or Linux.
- 💡 Single click to execute your script.
❗ Come back regularly to apply latest version for stronger privacy and security.

Why

Rich tweak pool to harden security & privacy of the OS and other software on it
Free (both free as in beer and free as in speech)
No need to run any compiled software that has access to your system, just run the generated scripts
Have full visibility into what the tweaks do as you enable them
Ability to revert (undo) applied scripts
Everything is transparent: both application and its infrastructure are open-source and automated
Easily extendable with own powerful templating language
Each script is independently executable without cross-dependencies

Extend scripts

You can either create an issue
Or send a PR:
1. Fork the repository
2. Add more scripts in respective script collection in collections folder.
  - 📖 If you're unsure about the syntax you can refer to the collection files | documentation.
  - 🙏 For any new script, please add revertCode and docs values if possible.
3. Send a pull request 👌

Development

See docs/development.md for Docker usage, running/building application, development best-practices along with other information related to development.

Architecture overview

Application

Powered by TypeScript, Vue.js and Electron 💪
- and driven by Domain-driven design, Event-driven architecture, Data-driven programming concepts.
Application uses highly decoupled models & services in different DDD layers.
📖 Read more on • Presentation • Application

AWS Infrastructure

It uses infrastructure from the following repository: aws-static-site-with-cd
- Runs on AWS 100% serverless and automatically provisioned using GitHub Actions.
- Maximum security & automation and minimum AWS costs are the highest priorities of the design.

GitOps: CI/CD to AWS

CI/CD is fully automated for this repo using different GIT events & GitHub actions.
- Versioning, tagging, creation of CHANGELOG.md and releasing is automated using bump-everywhere action
Everything that's merged in the master goes directly to production.
📖 Read more on CI/CD pipelines

6.9 KiB Raw Blame History