🌙 Open Sharia Enterprise
Open Sharia Enterprise (OSE) is an open-source platform for researching and building trustworthy,
Sharia-compliant enterprise products. It exists for organizations that need business software whose
rules, decisions, and foundations can be examined rather than treated as a black box.
OSE is for product people exploring that problem and early-career engineers who want to see how a
product platform is being built. This is a pre-alpha repository: the architecture and APIs will
change as product, research, assurance, and platform work develops.
This active OSE product monorepo holds product work, supporting research, and their governance and
automation.
This repository is one of the OSE Code Repositories (ose-projects), the seven repositories OSE
is built and maintained in. The other six have distinct roles: the independent private sibling
ose-private (Private) holds authorized operations,
RHINO supplies repository hygiene,
HIPPO supplies resource coordination,
py-typekit supplies typed result values,
ose-rules is a shared rules catalog, and
BeaverNest is an independent family product. Each of
the seven versions and releases on its own schedule; the name is navigation, not a shared release.
The repository comparison says which repository answers
which question.
External contributions are currently closed while the project stabilizes its product and engineering
patterns.
Choose the path that fits what you need:
🧭 Understand the product
OSE works toward enterprise systems that make Sharia compliance a design constraint from the start.
The repository brings together product delivery, Shariah and regulatory research, enterprise-domain
research, security and governance work, platform engineering, and public learning. Each stream moves
when its own evidence and dependencies are ready, not on one portfolio-wide stage.
The current product and public surfaces are:
- OSE Platform — the platform’s public website at oseplatform.com.
- OrganicLever — an active local-first productivity product workstream, with a marketing site,
web client, backend, and end-to-end tests.
- AyoKoding — public engineering research and learning drawn from work around the platform.
Priorities reflect user value, evidence, risk, dependencies, and capacity. Initiatives need discovery,
validation, and appropriate product, Shariah, security, and operational readiness checks.
See the plans index for planned and active work, and the
application map for current software responsibilities.
Where the work lives
OSE uses an Nx monorepo: one repository that contains several independently
deployable applications and shared libraries while Nx coordinates their development tasks.
| Location | What you will find |
|---|
apps/ | Product apps, public sites, command-line tools, and end-to-end test suites |
libs/ | Shared code used by applications |
docs/ | Tutorials, how-to guides, technical reference, and explanations |
specs/ | Product and behaviour specifications |
plans/ | Current and completed planning records |
🧰 Run OSE locally
This first run starts ose-www, the OSE Platform website, at http://localhost:3100 — a small,
visible way into the product that needs no knowledge of the other services.
Want a paced walkthrough with expected results and recovery steps? Follow
Getting started with OSE Public.
Supported platforms and prerequisites
macOS and Ubuntu Linux are supported. The Linux steps may work in WSL2 (Windows Subsystem for
Linux 2), but WSL2 is neither supported nor verified by this project. Native Windows is not
supported.
Before installing dependencies, have these tools available:
- Git to clone the repository.
- Volta to install the Node.js and npm versions pinned in
package.json.
- The .NET SDK used by the repository's F# projects.
- Rust (
rustfmt) only when you edit Rust course content; no workspace project is written in Rust.
- Rootless Podman and
jq only for container-based or broader local-tooling work. Neither is needed for
the first ose-www website run.
Follow Set up your development environment for
macOS or Ubuntu installation commands and recovery steps for a missing tool.
Clone and bootstrap
git clone https://github.com/wahidyankf/ose-public.git
cd ose-public
./hippo run --class transactional --resource-tier standard --disk-path . -- npm install
./hippo verifies the pinned upstream release before npm install installs dependencies, Git
hooks, and repository tooling. Follow the onboarding tutorial's focused check; install optional
tools only when your chosen work needs them. npm run doctor is a read-only check of every
declared toolchain and accepts no arguments. Only when it reports a missing or drifted toolchain,
provision the declared toolchains under a transactional reservation, then check again:
./hippo run --class transactional --resource-tier standard --disk-path . -- ./rhino toolchain provision --apply
npm run doctor
When the focused check is green, run the public website. If Cargo, Volta, or another tool it names
is still missing, return to the
setup guide rather than bypassing the check.
Find and run the first project
List the projects that Nx can run:
npm run nx:show -- projects
The list it prints includes ose-www, the public website. Start that one:
./hippo run --class service --resource-tier standard --disk-path . -- npm exec nx -- dev ose-www
Open http://localhost:3100 when the development server reports that it is ready.
Already using port 3100? Point the site somewhere else instead of guessing which process to stop:
OSE_WWW_PORT=4000 ./hippo run --class service --resource-tier standard --disk-path . -- npm exec nx -- dev ose-www
Then open http://localhost:4000 instead.
The Nx command guide explains project discovery and the other
targets you can run.
From there, read how OSE applications fit together
or explore the OSE Platform app itself.
Project status
OSE is pre-alpha. Expect breaking changes, evolving architecture, and experimental implementations.
The project uses TypeScript and Next.js for web applications, F# and Go for
backend and document-processing work, and pinned external releases of RHINO and HIPPO for repository tooling.
See the
technology-stack reference for the
current technical picture.
License
OSE is available under the MIT License. See the
licensing notice for the repository-wide statement.
