Update README.md
This commit is contained in:
@@ -1,8 +1,103 @@
|
|||||||
# zero-fucks-given
|
# ZFG
|
||||||
|
|
||||||
Z — Zero Friction
|
**Official meaning:** `Zero Friction Growth`
|
||||||
Architecture should make growth easy: adding modules, services, tenants, integrations, or developers should not require rewriting half the system.
|
**Unofficial meaning:** `Zero Fucks Given`
|
||||||
F — Flexible Foundations
|
|
||||||
Core infrastructure stays generic and reusable: auth, permissions, organizations, events, workflows, storage, notifications, APIs. Business-specific logic sits on top instead of contaminating the foundation.
|
## Z — Zero Friction
|
||||||
G — Growth-Ready
|
|
||||||
The system is designed to scale in multiple dimensions: more users, more data, more modules, more customers, more developers, and potentially more services.
|
Architecture should make growth easy.
|
||||||
|
|
||||||
|
Adding new modules, services, tenants, integrations, or developers should not require rewriting half of the system.
|
||||||
|
|
||||||
|
### Principles
|
||||||
|
|
||||||
|
* Modular architecture
|
||||||
|
* Low coupling
|
||||||
|
* Clear interfaces
|
||||||
|
* Easy onboarding
|
||||||
|
* Predictable project structure
|
||||||
|
* Minimal friction when adding new functionality
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## F — Flexible Foundations
|
||||||
|
|
||||||
|
The core infrastructure should stay generic, reusable, and extensible.
|
||||||
|
|
||||||
|
Business-specific logic should sit on top of the foundation instead of contaminating it.
|
||||||
|
|
||||||
|
### Core building blocks
|
||||||
|
|
||||||
|
* Authentication
|
||||||
|
* Authorization
|
||||||
|
* Roles & permissions
|
||||||
|
* Organizations
|
||||||
|
* Events
|
||||||
|
* Workflows
|
||||||
|
* Storage
|
||||||
|
* Notifications
|
||||||
|
* API layer
|
||||||
|
* Integrations
|
||||||
|
* Configuration
|
||||||
|
|
||||||
|
### Principles
|
||||||
|
|
||||||
|
* Reusable core
|
||||||
|
* Configuration-driven behavior
|
||||||
|
* Extensible modules
|
||||||
|
* Replaceable infrastructure
|
||||||
|
* Clear separation between core and business logic
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## G — Growth-Ready
|
||||||
|
|
||||||
|
The system should be designed to scale in multiple dimensions.
|
||||||
|
|
||||||
|
Not only more traffic, but also more customers, data, modules, developers, integrations, and services.
|
||||||
|
|
||||||
|
### Principles
|
||||||
|
|
||||||
|
* Horizontal scaling
|
||||||
|
* Multi-tenancy
|
||||||
|
* Async processing
|
||||||
|
* Observability
|
||||||
|
* Independent modules
|
||||||
|
* Independent deployment paths where needed
|
||||||
|
* Efficient data growth
|
||||||
|
* Clear service boundaries
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Philosophy
|
||||||
|
|
||||||
|
```text
|
||||||
|
ZFG
|
||||||
|
│
|
||||||
|
├── Z — Zero Friction
|
||||||
|
│ ├── modular architecture
|
||||||
|
│ ├── low coupling
|
||||||
|
│ ├── clear interfaces
|
||||||
|
│ └── easy onboarding
|
||||||
|
│
|
||||||
|
├── F — Flexible Foundations
|
||||||
|
│ ├── reusable core
|
||||||
|
│ ├── configuration-driven behavior
|
||||||
|
│ ├── extensible modules
|
||||||
|
│ └── replaceable infrastructure
|
||||||
|
│
|
||||||
|
└── G — Growth-Ready
|
||||||
|
├── horizontal scaling
|
||||||
|
├── multi-tenancy
|
||||||
|
├── async processing
|
||||||
|
├── observability
|
||||||
|
└── independent deployment paths
|
||||||
|
```
|
||||||
|
|
||||||
|
## Motto
|
||||||
|
|
||||||
|
> **Build with Zero Friction. Stay Flexible. Be Growth-Ready.**
|
||||||
|
|
||||||
|
Or, internally:
|
||||||
|
|
||||||
|
> **Zero Fucks Given.**
|
||||||
|
|||||||
Reference in New Issue
Block a user