privacy.sexy/README.md

privacy.sexy

Web tool to enforce privacy & security best-practices on Windows, because privacy is sexy 🍑🍆

https://privacy.sexy

Why

• You don't need to run any compiled software that has access to your system, just run the generated scripts.
• It's open source, both application & infrastructure is 100% transparent
  • Fully automated C/CD pipeline to AWS for provisioning serverless infrastructure using GitHub actions.
• Have full visibility into what the tweaks do as you enable them.
• Ability to revert applied scripts
• Easily extendable

Extend scripts

• Fork it & add more scripts in application.yaml and send a pull request 👌
• 📖 More: extend scripts | CONTRIBUTING.md

Commands

• Project setup: npm install
• Testing
  • Run unit tests: npm run test:unit
  • Lint: npm run lint
• Webpage
  • Development: npm run serve to compile & hot-reload for development.
  • Production: npm run build to prepare files for distribution.
  • Or run using Docker:
    1. Build: docker build -t undergroundwires/privacy.sexy:0.5.0 .
    2. Run: docker run -it -p 8080:80 --rm --name privacy.sexy-0.5.0 undergroundwires/privacy.sexy:0.5.0

Architecture

Application

• Powered by TypeScript + Vue.js 💪
  • and driven by Domain-driven design, Event-driven architecture, Data-driven programming concepts.
• Application uses highly decoupled models & services in different DDD layers.
  • Domain layer is where the application is modelled with validation logic.
  • Presentation Layer
    • Consists of Vue.js components & UI stuff.
    • Event driven as in components simply listens to events from the state and act accordingly.
  • Application Layer
    • Keeps the application state
      • The state is a mutable singleton & event producer.
    • The application is defined & controlled in a single YAML file (see Data-driven programming)

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.