An open API service indexing awesome lists of open source software.

https://github.com/wahidyankf/open-sharia-enterprise

Open-source Sharia-compliant enterprise platform. Building foundations in the open. Early Phase 0, pre-alpha. No timelinesβ€”building it right.
https://github.com/wahidyankf/open-sharia-enterprise

compliance-as-code devsecops enterprise erp fintech halal hugo indonesia indonesian islamic-finance monorepo nx open-source pre-alpha sharia-compliant typescript

Last synced: 5 months ago
JSON representation

Open-source Sharia-compliant enterprise platform. Building foundations in the open. Early Phase 0, pre-alpha. No timelinesβ€”building it right.

Awesome Lists containing this project

README

          

# πŸŒ™ 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)) - Shares the technological research and domain knowledge we develop for this project. What we learn while building Open Sharia Enterprise becomes accessible to the wider community through educational content

> ⚠️ **PRE-ALPHA STATUS**: This project is in early development and **NOT ready for production use**. Core architecture and patterns are still being established. APIs and implementations may change significantly. **Contributions and pull requests are not being accepted** at this time.

## 🎯 Motivation

**The Opportunity**: Islamic enterprise (finance, commerce, cooperatives, and beyond) represents a multi-trillion dollar global market, creating massive demand for Sharia-compliant business systems. While purpose-built platforms exist, they're typically proprietary, expensive, and limited to specific domains. Many organizations struggle with legacy systems retrofitted for Sharia compliance. The gap? Accessible, open-source solutions with built-in compliance and radical transparencyβ€”serving the entire spectrum of Islamic business needs.

**Our Solution**: We're building a global open-source platform with Sharia-compliance at its coreβ€”starting with ERP foundations and expanding across enterprise domains (finance, commerce, cooperatives, supply chain, and more). We're making trustworthy, transparent business systems accessible to any organization worldwideβ€”regardless of size, region, or industry.

**What We Believe:**

- πŸ•Œ **Sharia-compliance as a foundation** should be built into enterprise solutions from the ground up, not bolted on later
- πŸ”“ **Transparency and openness** in the code helps build trust in Sharia-compliant enterprise solutions
- 🌐 **Open source by default** - We believe in radical transparency unless it compromises security and/or privacy protection
- πŸ€– **AI-assisted development, not vibe-coding** - We use AI tools systematically to enhance productivity and code quality, not as a substitute for thoughtful engineering
- 🀝 **Community collaboration** can accelerate the development of accessible and culturally sensitive business tools
- πŸ’‘ **Innovation** across enterprise domains (financial services, supply chain, HR, and more) should be driven by open standards and shared knowledge
- πŸ“š **Share what we learn** - The research and technological knowledge we develop gets shared through [ayokoding.com](https://ayokoding.com), making our learning journey useful to the wider community
- πŸ›‘οΈ **Governance and security from day one** are essential for enterprise solutions - good governance and sound security practices must be architectural foundations, not afterthoughts
- 🎯 **Production ready from beta** - Every feature follows clear quality stages: Alpha (experimental, not production ready), Beta (production ready: secure, scalable, documented), Stable (battle-tested, proven in production)
- πŸ—οΈ **Long-term foundation over quick wins** - This is a life-long project building solid foundations now
- πŸ” **Parallel infrastructure development** - Security operations, compliance automation, and red teaming tools are being built ALONGSIDE the enterprise platform from day one, not added later as afterthoughts

πŸš€ Our mission is to democratize access to trustworthy, Sharia-compliant enterprise technology for organizations of all sizes, regardless of region or industry.

## πŸ“œ Freedom to Use

This project is open-source and licensed under the **MIT License**. This means you are free to use this project for:

- 🎯 **Commercial projects** - Build commercial products and services
- 🏒 **Enterprise solutions** - Deploy in enterprise environments
- πŸ”¬ **Research and education** - Use for academic and educational purposes
- πŸ› οΈ **Modifications and derivatives** - Fork, modify, and create derivative works
- πŸ“¦ **Distribution** - Include in your own projects or distribute freely

βœ… **No restrictions.** You can use this code for anything you want, with complete freedom and flexibility. The MIT License grants you broad rights while maintaining proper attribution.

## πŸ—ΊοΈ Development Roadmap

This project is being developed with a **phased approach** to establish strong Sharia-compliance foundations and gradually expand enterprise capabilities:

### πŸ”¬ Phase 0: Setup and Research

Establishing the foundational infrastructure and conducting research to inform architectural decisions. This phase is building the solid foundation for a life-long projectβ€”thoughtful groundwork now ensures we can build a trustworthy, secure, and compliant enterprise platform.

**Two parallel tracks running simultaneously:**

**πŸ—οΈ Enterprise Platform Track:**

- πŸ› οΈ **Development Tooling & Processes** - Infrastructure (Volta, formatting, git hooks), documentation framework (DiΓ‘taxis, Obsidian), AI agents, planning system
- πŸ—οΈ **Architecture & Design** - Monorepo architecture (Nx workspace), core patterns, technology evaluation
- πŸ€– **AI Research** - AI/ML applications, LLM integration, intelligent automation, AI-assisted development
- πŸ” **Sharia Compliance Research** - Evaluating global Islamic standards, regional variations, and multi-jurisdiction requirements
- ☁️ **Infrastructure Creation** - Cloud infrastructure, deployment pipelines, CI/CD setup

**πŸ” Security & Compliance Infrastructure Track (IN PARALLEL):**

- πŸ›‘οΈ **Security Operations Tooling** - Building monitoring, incident response, and security testing capabilities from the ground up
- 🎯 **Red Teaming Infrastructure** - Offensive security tools to continuously test and strengthen platform defenses as we build
- πŸ“‹ **Compliance Automation** - Automated validation, audit trails, and regulatory reporting tools being developed alongside platform features
- πŸ”’ **DevSecOps Research** - Information security frameworks, threat modeling, compliance as code, security operations foundations

### πŸ“Š Phase 1: ERP Foundation

Building a solid enterprise foundation with ERP capabilities to support core business operations:

- πŸ’° **Financial Management** - Accounting & finance, asset management, reporting & analytics with Sharia compliance
- πŸ”— **Operations Management** - Supply chain (halal-compliant), inventory control, procurement & vendor management
- πŸ‘₯ **People & Customer Management** - HR & payroll (Sharia-compliant), sales & CRM, customer relationships
- πŸ•Œ **Execution & Compliance** - Project management, resource allocation, Sharia compliance framework

### 🌍 Phase 2: Enterprise Domain Expansion

Expand across all enterprise domains following established Islamic standards:

**🏦 Financial Services:**

- πŸ’³ Payments and transaction processing (halal-compliant)
- 🏦 Banking services and lending (Sharia-compliant contracts: murabaha, ijarah, etc.)
- πŸ“Š Investment and wealth management (Islamic finance principles)
- πŸ’° Zakat calculation and distribution systems

**πŸ›οΈ Commerce & Trade:**

- πŸ›’ E-commerce platforms (halal product verification)
- πŸ“¦ Supply chain management (halal certification tracking)
- 🀝 B2B marketplaces (Shariah-compliant contracts)
- 🌐 Cross-border trade (Islamic trade finance)

**🀝 Cooperatives & Community:**

- 🏘️ Islamic cooperatives management (musharakah, mudharabah)
- πŸ’ Community finance and mutual aid (takaful principles)
- πŸ“± Microfinance and social impact (Shariah-compliant)
- 🎯 Waqf and endowment management

**🌏 Global Compliance Framework:**

- πŸ•Œ International Islamic standards (based on Phase 0 research)
- 🌍 Multi-jurisdiction compliance (various countries and regions)
- πŸ“– Regional Shariah interpretations and requirements
- ✈️ Cross-border operations and regulatory harmonization

### πŸ” Security & Compliance Infrastructure (Evolving in Parallel)

**These capabilities are being developed ALONGSIDE the enterprise platform from Phase 0 onwardβ€”not as future additions, but as parallel infrastructure that grows with the platform:**

- πŸ›‘οΈ **Security Operations Tooling** - Built-in monitoring and incident response capabilities to protect the enterprise platform and its users
- 🎯 **Red Teaming Infrastructure** - Offensive security tools to continuously test and strengthen platform defenses as we build
- πŸ“‹ **Compliance Automation** - Automated validation, audit trails, and regulatory reporting to maintain Sharia and regulatory compliance across the platform
- πŸ” **Enterprise-Grade Security** - Robust security operations built-in from the start, not bolted on later

**Parallel Development Approach:** As we build each platform feature (ERP modules, financial services, commerce, cooperatives), the corresponding security monitoring, compliance validation, and testing tools are developed in tandem. Security and compliance infrastructure evolves with the platform, ensuring they're architected together from day one.

### πŸ’­ Why This Approach?

- πŸ”¬ **Research before building** - Phase 0 establishes foundations through global compliance, security, and AI research before implementation
- 🌍 **Global from the start** - Designed for multi-jurisdiction support and international Islamic standards from day one
- πŸ—οΈ **ERP as foundation** - Enterprise Resource Planning provides core infrastructure for all business operations across domains
- πŸ•Œ **Sharia-compliance from day one** - Built-in compliance architecture following established Islamic standards, not bolt-on features
- πŸ” **Parallel security infrastructure** - Security operations, red teaming tools, and compliance automation are developed ALONGSIDE platform features from Phase 0 onwardβ€”not added later, but built together from the start
- πŸ›‘οΈ **Security by design** - DevSecOps and compliance-as-code integrated from the start, ensuring security and compliance are architectural foundations
- πŸ“ˆ **Domain expansion over geographic expansion** - Start with ERP core, then expand to finance, commerce, cooperatives globally rather than one region at a time
- βš–οΈ **Gradual expansion** - Phased approach reduces complexity while ensuring quality across all enterprise domains
- πŸ—οΈ **Long-term thinking** - Building solid global enterprise foundations now, with security and compliance infrastructure that evolves in parallel with the platform

## 🀝 Contributing

πŸ”’ **Contributions are currently closed** until the project patterns and architecture are stable enough to accept external contributions. This ensures we maintain code quality and regulatory compliance as we build the foundation.

However, πŸŽ‰ **you are welcome to fork this repository!** Feel free to:

- 🍴 Create your own fork for your region or use case
- πŸ§ͺ Experiment with extensions and modifications
- πŸ—οΈ Build upon this project for your specific needs
- πŸ“€ Share your improvements with the community

✨ Once the core patterns are established and the project is mature enough, we will open the contribution process. We look forward to collaborating with the community in the future!

## πŸ› οΈ Tech Stack

🎯 **Guiding Principle:**
We choose technologies that keep you free. Your data stays yours, in open formats you can take anywhere. No vendor traps, no proprietary formats, no forced dependencies.

**What this means:**

- πŸ“ **Your data is portable** - Plain text and open formats you can read anywhere
- ☁️ **No forced dependencies** - Pick your own hosting, database, or infrastructure
- πŸ“€ **Easy migration** - Export and move to alternatives anytime
- πŸ” **Community ownership** - You control your technology choices

We prefer open-source tools, but we'll use non-open-source software if it respects these principles.

πŸ’‘ **Example:** We use [Obsidian](https://obsidian.md/) for documentation (not open-source), but all docs are plain markdown files. You can open them in any text editorβ€”no lock-in, complete freedom.

πŸ“¦ **Project Tooling:**

- βš™οΈ Node.js & npm - Project management, development tools, and scripts
- 🎨 Prettier - Code formatting
- πŸͺ Husky & lint-staged - Git hooks and automated checks
- βœ… Commitlint - Commit message validation

πŸš€ **Main Service:**
The tech stack for the main enterprise platform is currently being evaluated. Updates will be provided as architectural decisions are finalized. Technology selection will follow our open-source principles and keep you free to choose.

## πŸš€ Getting Started

### πŸ“‹ Prerequisites

πŸ”§ **Project Tooling & Infrastructure:**

- πŸ“¦ **Node.js**: 24.11.1 LTS (pinned via Volta)
- πŸ“¦ **npm**: 11.6.3 (pinned via Volta)
- ⚑ **Volta**: [Install Volta](https://docs.volta.sh/guide/getting-started) for automatic Node.js/npm version management

> πŸ’‘ **Note:** Node.js is used for project tooling, infrastructure, and development tools. The tech stack for the main enterprise platform is currently being decided and may be implemented in a different technology.

### πŸ“₯ Installation

```bash
npm install
```

### πŸ“‚ Project Structure

```
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
```

### πŸ—οΈ Monorepo Architecture

This project uses **Nx** to manage applications and libraries:

- **`apps/`** - Deployable applications (current: `ose-platform-web`, `ayokoding-web`, `ayokoding-cli`)
- **`libs/`** - Reusable libraries with language prefixes (`ts-*`, future: `java-*`, `py-*`) - currently empty
- **`apps-labs/`** - Experimental apps and POCs (framework evaluation, language exploration) - currently empty

**Quick Commands**:

```bash
nx dev [app-name] # Start development server
nx build [app-name] # Build specific project
nx affected:build # Build only affected projects
nx graph # Visualize dependencies
```

**Learn More**:

- [Monorepo Structure Reference](./docs/reference/re__monorepo-structure.md)
- [How to Add New App](./docs/how-to/hoto__add-new-app.md)
- [How to Add New Library](./docs/how-to/hoto__add-new-lib.md)
- [How to Run Nx Commands](./docs/how-to/hoto__run-nx-commands.md)

## πŸ’» Development

### ✨ Code Quality & Git Hooks

This project uses automated tools to maintain code quality:

- 🎨 **Prettier** - Automatic code formatting
- πŸͺ **Husky** - Git hooks for automated checks
- πŸ“‹ **Lint-staged** - Run formatters on staged files only
- βœ… **Commitlint** - Enforce [Conventional Commits](https://www.conventionalcommits.org/)

**Automated Checks**:

- **Pre-commit**:
- Formats staged files (JS/TS, JSON, Markdown, YAML, CSS, HTML)
- **ayokoding-web automation** (when content changes detected):
- Rebuilds `ayokoding-cli` (~250ms cached)
- Updates titles from filenames (~40ms)
- Regenerates navigation (~25ms)
- Auto-stages changes
- **Commit-msg**: Validates commit message format

For complete details on tools, hook workflow, and troubleshooting, see [Code Quality Convention](./governance/development/quality/code.md) and [Commit Message Convention](./governance/development/workflow/commit-messages.md). For ayokoding-web automation details, see [Pre-commit Automation](./apps/ayokoding-cli/README.md#pre-commit-automation).

## πŸ“š Documentation

Documentation is organized using the [DiΓ‘taxis framework](https://diataxis.fr/) with four categories: Tutorials (learning), How-To (problem-solving), Reference (lookup), and Explanation (understanding).

### πŸ“‚ Quick Navigation

- πŸŽ“ [Tutorials](./docs/tutorials/) - Learning-oriented guides
- πŸ”§ [How-To](./docs/how-to/) - Problem-solving guides
- πŸ“– [Reference](./docs/reference/) - Technical reference
- πŸ’‘ [Explanation](./docs/explanation/) - Conventions and concepts

**Viewing Tip**: The `docs/` folder works as an [Obsidian](https://obsidian.md/) vault for enhanced navigation and graph view.

For complete documentation framework details, see [DiΓ‘taxis Framework](./governance/conventions/meta/diataxis-framework.md) and [`docs/README.md`](./docs/README.md).

## πŸ“œ License

This project is licensed under the **MIT License** - see the [Freedom to Use](#-freedom-to-use) section for details on what you can do with this code.

## 🚧 Project Status

⚠️ **PRE-ALPHA** - This project is in early development and **NOT ready for production use**.

**Current Phase: Phase 0 (Setup and Research)**

We are establishing foundational infrastructure and conducting research to inform architectural decisions. **Two parallel tracks are running simultaneously:**

**Enterprise Platform Track:**

- πŸ”¨ Core infrastructure setup (Volta, code formatting, commit validation, documentation structure)
- πŸ“‹ Project planning and architecture design
- πŸ—οΈ Foundation patterns being established
- πŸ” Researching global Islamic standards and multi-jurisdiction compliance frameworks
- πŸ€– AI research and integration exploration

**Security & Compliance Infrastructure Track (IN PARALLEL):**

- πŸ›‘οΈ Building security operations tooling from the ground up
- 🎯 Developing red teaming infrastructure to test platform defenses
- πŸ“‹ Creating compliance automation and audit trail systems
- πŸ”’ Researching DevSecOps frameworks and threat modeling approaches

**Not Yet Available:**

- ❌ No production code
- ❌ No stable APIs
- ❌ No security hardening
- ❌ No deployment infrastructure
- ❌ No compliance certifications
- ❌ Not accepting contributions or pull requests from public

**What to Expect:**

- πŸ”„ Breaking changes without notice
- πŸ“ Architecture and design still evolving
- πŸ§ͺ Experimental implementations
- πŸ“š Documentation is work-in-progress

⚠️ **Do NOT use this project for production systems.** Wait for a stable release before considering production deployment.