wahidyankf/ose-public

# 🌙 Open Sharia Enterprise ✨ An enterprise solutions platform for Sharia-compliant business systems. 🌐 **Live Sites**: - **OSE Platform** ([oseplatform.com](https://oseplatform.com)) - Main platform website (under construction) - **AyoKoding** ([ayokoding.com](https://ayokoding.com)) - Engineering research and learnings from this project, shared publicly as educational content - **OrganicLever** ([organiclever.com](https://www.organiclever.com/)) - Landing and promotional website (Phase 1, in development) ## 🚧 Project Status **Current Phase: Phase 1 (OrganicLever - Productivity Tracker)** Building OrganicLever, a full-stack individual productivity tracker: - 🌐 **Landing site**: [organiclever.com](https://www.organiclever.com/) ([organiclever-fe](./apps/organiclever-fe/)) - Next.js promotional website - ✅ **Phase 0 complete**: [ayokoding.com](https://ayokoding.com), [oseplatform.com](https://oseplatform.com), AI agents, governance, CLI tools **Next Phase: Phase 2 (SMB Application)** - Small and medium business application building on OrganicLever's foundation. **What to Expect:** - 🔄 Breaking changes without notice - 📐 Architecture still evolving - 🧪 Experimental implementations See **[ROADMAP.md](./ROADMAP.md)** for complete development phases and strategy. ## 🚀 Getting Started ### 📋 Prerequisites - **Node.js** 24.13.1 LTS & **npm** 11.10.1 (managed via [Volta](https://docs.volta.sh/guide/getting-started)) ### 📥 Installation ``` npm install ``` ## 🛠️ Tech Stack **Guiding Principle**: Technologies that keep you free - open formats, portable data, no vendor lock-in. **Phase 0 (Complete):** - Node.js & npm (via Volta) - Tooling and development infrastructure - Hugo (Extended) - Static sites (oseplatform-web) - Golang - CLI tools ([ayokoding-cli](./apps/ayokoding-cli/), [rhino-cli](./apps/rhino-cli/)) and future security infrastructure **Current Phase 1 (OrganicLever):** - Frontend (landing): Next.js + TypeScript - Infrastructure: Kubernetes See **[ROADMAP.md](./ROADMAP.md)** for complete tech stack evolution across all phases. ## 📂 Project Structure This project uses **Nx** to manage applications and libraries: ``` open-sharia-enterprise/ ├── apps/ # Deployable applications (Nx monorepo) ├── apps-labs/ # Experimental apps and POCs (NOT in Nx monorepo) │ └── README.md # Labs directory documentation ├── libs/ # Reusable libraries (Nx monorepo, flat structure) ├── docs/ # Project documentation (Diataxis framework) │ ├── tutorials/ # Learning-oriented guides │ ├── how-to/ # Problem-oriented guides │ ├── reference/ # Technical reference │ └── explanation/ # Conceptual documentation ├── plans/ # Project planning documents │ ├── in-progress/ # Active project plans │ ├── backlog/ # Planned projects for future │ └── done/ # Completed and archived plans ├── nx.json # Nx workspace configuration ├── tsconfig.base.json # Base TypeScript configuration ├── package.json # Project manifest with npm workspaces └── README.md # This file ``` **Applications** (`apps/`): - **Sites**: [`oseplatform-web`](./apps/oseplatform-web/), [`ayokoding-web`](./apps/ayokoding-web/), [`organiclever-fe`](./apps/organiclever-fe/), [`organiclever-be`](./apps/organiclever-be/), [`organiclever-fe-e2e`](./apps/organiclever-fe-e2e/), [`organiclever-be-e2e`](./apps/organiclever-be-e2e/), [`wahidyankf-web`](./apps/wahidyankf-web/), [`wahidyankf-web-fe-e2e`](./apps/wahidyankf-web-fe-e2e/) - **CLI tools**: [`ayokoding-cli`](./apps/ayokoding-cli/), [`rhino-cli`](./apps/rhino-cli/), [`oseplatform-cli`](./apps/oseplatform-cli/) - **Polyglot demo apps**: extracted 2026-04-18 to the downstream [`ose-primer`](https://github.com/wahidyankf/ose-primer) template repository, which is now authoritative for the polyglot showcase (Go, Java, Elixir, F#, Python, Rust, Kotlin, TypeScript, C#, Clojure backends + Next.js, TanStack Start, Flutter Web frontends). **Libraries** (`libs/`): Reusable shared code **Labs** (`apps-labs/`): Standalone experiments and POCs (outside Nx) **Learn More**: [Monorepo Structure Reference](./docs/reference/monorepo-structure.md) | [How to Add New App](./docs/how-to/add-new-app.md) | [How to Add New Library](./docs/how-to/add-new-lib.md) | [How to Run Nx Commands](./docs/how-to/run-nx-commands.md) ## 💻 Development **Code Quality**: Automated checks run on every commit (Prettier formatting, Commitlint validation, markdown linting). **Common Commands**: ``` npm run build # Build all projects npm run test # Run tests npm run lint # Lint code nx dev [app-name] # Start development server nx build [app-name] # Build specific project nx affected -t build # Build only affected projects nx affected -t test:quick # Run fast quality gate for affected projects nx graph # Visualize dependencies ``` See [Code Quality](./governance/development/quality/code.md) and [Commit Messages](./governance/development/workflow/commit-messages.md) for details. ## 📊 CI & Test Coverage All projects enforce ≥90% test coverage as part of `test:quick`. Coverage is uploaded to [Codecov](https://codecov.io/gh/wahidyankf/ose-public) on every push to `main`. **Quality gates**: pre-commit hooks (formatting, linting), pre-push hooks (`typecheck`, `lint`, `test:quick` for affected projects), [PR Quality Gate](./.github/workflows/pr-quality-gate.yml), and [Codecov Upload](./.github/workflows/codecov-upload.yml) on push to `main`. - OSE Platform - [](https://github.com/wahidyankf/ose-public/actions/workflows/test-and-deploy-oseplatform-web.yml) - [`oseplatform-web`](./apps/oseplatform-web/) [](https://codecov.io/gh/wahidyankf/ose-public) - [`oseplatform-cli`](./apps/oseplatform-cli/) [](https://codecov.io/gh/wahidyankf/ose-public) - AyoKoding - [](https://github.com/wahidyankf/ose-public/actions/workflows/test-and-deploy-ayokoding-web.yml) - [`ayokoding-web`](./apps/ayokoding-web/) [](https://codecov.io/gh/wahidyankf/ose-public) - [`ayokoding-cli`](./apps/ayokoding-cli/) [](https://codecov.io/gh/wahidyankf/ose-public) - OrganicLever - [](https://github.com/wahidyankf/ose-public/actions/workflows/test-and-deploy-organiclever.yml) - [`organiclever-fe`](./apps/organiclever-fe/) [](https://codecov.io/gh/wahidyankf/ose-public) - [`organiclever-be`](./apps/organiclever-be/) [](https://codecov.io/gh/wahidyankf/ose-public) - Wahidyankf - [](https://github.com/wahidyankf/ose-public/actions/workflows/test-and-deploy-wahidyankf-web.yml) - [`wahidyankf-web`](./apps/wahidyankf-web/) [](https://codecov.io/gh/wahidyankf/ose-public) - [`rhino-cli`](./apps/rhino-cli/) - [](https://codecov.io/gh/wahidyankf/ose-public) For polyglot demo app CI badges, see the [`ose-primer`](https://github.com/wahidyankf/ose-primer) repository. ## 📚 Documentation Organized using the [Diátaxis framework](https://diataxis.fr/): [Tutorials](./docs/tutorials/) (learning), [How-To](./docs/how-to/) (problem-solving), [Reference](./docs/reference/) (lookup), [Explanation](./docs/explanation/) (understanding). See [`docs/README.md`](./docs/README.md) for details. ## 🔗 Related Repositories - **[`ose-primer`](https://github.com/wahidyankf/ose-primer)** — public, MIT-licensed template repository derived from `ose-public`. Packages scaffolding (governance, AI agents, skills, conventions, CI harness, polyglot demo apps) into a starting point. `ose-public` is upstream source of truth; propagation and adoption flows are defined by the [ose-primer sync convention](./governance/conventions/structure/ose-primer-sync.md). For the upstream/downstream relationship and license difference, see [Related Repositories reference](./docs/reference/related-repositories.md). ## 🎯 Motivation Our mission is to democratize access to trustworthy, Sharia-compliant enterprise technology for organizations of all sizes, regardless of region or industry. **The Opportunity:** - Islamic enterprise (finance, commerce, cooperatives) is a multi-trillion dollar global market - Existing platforms are proprietary, expensive, and domain-limited - Most organizations rely on legacy systems retrofitted for Sharia compliance - The gap: open-source, compliance-first solutions with radical transparency **Our Solution:** - Progressive complexity: individual (Phase 1) → SMB (Phase 2) → enterprise (Phase 3) - Each phase funds the next; Phase 1/2 success funds Phase 3's certification budget - Sharia-compliance built in from the ground up, not bolted on after **What We Believe:** - 🕌 **Sharia-compliance as a foundation** - Built in from the ground up, not bolted on later - 🔓 **Transparency builds trust** - Open source code enables community verification of Sharia compliance - 🤖 **AI-assisted development** - Systematic use of AI tools to enhance productivity and code quality - 🛡️ **Security and governance from day one** - Architectural foundations, not afterthoughts - 📚 **Learning in public** - Share our research and knowledge through [ayokoding.com](https://ayokoding.com) - 🏗️ **Long-term foundation over quick wins** - Building solid foundations for a life-long project For complete principles, see [governance/principles/](./governance/principles/README.md). ## 🤝 Contributing 🔒 **Contributions are currently closed** while we stabilize the architecture and patterns. 🎉 **Forking is welcome!** Build your own version for your region or use case — once the foundation is solid, we'll open contributions to the community. ## 📜 License This repository uses **per-directory licensing** guided by: implementation code (HOW) can be MIT; behavioral specifications (WHAT) must be FSL to prevent clean-room engineering of competing products. - **Product apps and behavioral specs** ([FSL-1.1-MIT](./LICENSE)): Product apps, product specs, and all E2E test suites are FSL-licensed. Each product app scopes the competing-use restriction to its domain - **Shared libraries** ([MIT](./libs/golang-commons/LICENSE)): All `libs/` are MIT-licensed. (The polyglot demo apps previously stored under `apps/a-demo-*` and `specs/apps/a-demo/` were extracted 2026-04-18 to the downstream [`ose-primer`](https://github.com/wahidyankf/ose-primer) template, which is MIT throughout.) The FSL-1.1-MIT license converts to MIT on a **rolling per-version basis**: each commit becomes MIT-licensed 2 years after its first public distribution. See [LICENSING-NOTICE.md](./LICENSING-NOTICE.md) for full details | [LICENSE](./LICENSE) for the root license text | [Licensing Convention](./governance/conventions/structure/licensing.md) for internal rules.

标签：Development Phase, Enterprise, EVTX分析, GNU通用公共许可证, Golang, Hugo, IPv6支持, MITM代理, Node.js, OrganicLever, Productivity Tracker, Sharia-compliant, Tech Stack, TypeScript, Volta, 企业平台, 伊斯兰教法合规, 可移植数据, 子域名突变, 学习公开, 安全插件, 安全编程, 开放格式, 开源, 无供应商锁定, 生产力追踪, 阶段1, 静态站点生成