1bcc6c8b2b
- Simplify `README.md` by creating and moving some documentation to `architecture.md`. - Add more documentation for state handling between layers. - Improve some documentation to use clearer language.
4.0 KiB
Architecture overview
This repository consists of:
- A layered application.
- AWS infrastructure as code and instructions to host the website.
- GitOps practices for development, maintenance and deployment.
Layered application
Application is
- 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:
- presentation layer (see presentation.md),
- application layer (see application.md),
- and domain layer.
Application layer depends on and consumes domain layer. Presentation layer consumes and depends on application layer along with domain layer. Application and presentation layers can communicate through domain model.
Application state
State handling uses an event-driven subscription model to signal state changes and special functions to register changes. It does not depend on third party packages.
Each layer treat application layer differently.
- Each component holds their own state about presentation-related data.
- Components register shared state changes into application state using functions.
- Components listen to shared state changes using event subscriptions.
- 📖 Read more: presentation.md | Application state.
- Stores the application-specific state.
- The state it exposed for read with getter functions and set using setter functions, setter functions also fire application events that allows other parts of application and the view in presentation layer to react.
- So state is mutable, and fires related events when mutated.
- 📖 Read more: application.md | Application state.
It's comparable with flux (redux) or flux-like (vuex) patterns. Flux component "view" is presentation layer in Vue. Flux functions "dispatcher", "store" and "action creation" functions lie in the application layer. A difference is that application state in privacy.sexy is mutable and lies in single flux "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
AWS infrastructure
The web-site runs on serverless AWS infrastructure. Infrastructure is open-source and deployed as code. aws-static-site-with-cd project includes the source code.
The design priorities highest security then minimizing cloud infrastructure costs.
This project includes GitHub Actions to automatically provision the infrastructure with zero-touch and without any "hidden" steps, ensuring everything is open-source and transparent. Git repositories includes all necessary instructions and automation with GitOps practices.
GitOps
CI/CD is fully automated using different Git events and GitHub actions. This repository uses bump-everywhere to automate versioning, tagging, creation of CHANGELOG.md and GitHub releases. A dedicated workflow creates desktop installers and executables and attaches them into GitHub releases.
Everything that's merged in the master goes directly to production.
📖 Refer to ci-cd.md to read more on CI/CD pipelines.
