{"id":48540062,"url":"https://github.com/mahou-labs/shiru","last_synced_at":"2026-04-08T04:01:26.347Z","repository":{"id":344261124,"uuid":"1179917479","full_name":"mahou-labs/shiru","owner":"mahou-labs","description":"The OSS documentation platform","archived":false,"fork":false,"pushed_at":"2026-04-07T20:16:52.000Z","size":3585,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-07T20:27:33.641Z","etag":null,"topics":["agents","ai","documentation","mcp","robots-txt"],"latest_commit_sha":null,"homepage":"https://shiru.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mahou-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-12T14:11:39.000Z","updated_at":"2026-04-03T02:26:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mahou-labs/shiru","commit_stats":null,"previous_names":["mahou-labs/shiru"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/mahou-labs/shiru","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahou-labs%2Fshiru","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahou-labs%2Fshiru/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahou-labs%2Fshiru/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahou-labs%2Fshiru/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mahou-labs","download_url":"https://codeload.github.com/mahou-labs/shiru/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahou-labs%2Fshiru/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31539229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"online","status_checked_at":"2026-04-08T02:00:06.127Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agents","ai","documentation","mcp","robots-txt"],"created_at":"2026-04-08T04:01:25.786Z","updated_at":"2026-04-08T04:01:26.341Z","avatar_url":"https://github.com/mahou-labs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"apps/site/public/favicon.svg\" /\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\".github/logo-dark.svg\" /\u003e\n    \u003cimg alt=\"Shiru\" src=\".github/logo-dark.svg\" width=\"48\" /\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eShiru\u003c/h1\u003e\n\nShiru is an open-source alternative to [Mintlify](https://mintlify.com) for building polished, well-structured documentation that works equally well for people reading it and for AI agents consuming it. No vendor lock-in, no per-seat pricing.\n\n## Tech Stack\n\n- **Monorepo**: Turborepo + Bun\n- **Frontend**: React 19 + TanStack Router (SPA) + TailwindCSS v4\n- **Backend**: Hono + oRPC (type-safe APIs)\n- **Auth**: Better Auth (with organization plugin)\n- **Database**: Drizzle ORM\n- **Billing**: Polar\n- **Linting/Formatting**: OxLint + OxFmt\n- **UI**: Shared `@shiru/ui` component library (Base UI + CVA)\n\n## Running Locally\n\n### Prerequisites\n\n- [Bun](https://bun.sh/) (v1.0+)\n- [Docker](https://www.docker.com/) (for PostgreSQL)\n\n### Setup\n\n1. Clone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/mahou-labs/shiru.git\ncd shiru\nvp install\n```\n\n2. Start the PostgreSQL database:\n\n```bash\nvp run db:start\n```\n\n3. Copy the environment files and configure them:\n\n```bash\ncp apps/api/.env.example apps/api/.env\ncp apps/dashboard/.env.example apps/dashboard/.env\n```\n\n4. Push the database schema:\n\n```bash\nvp run db:push\n```\n\n5. Start the development servers:\n\n```bash\nvp run dev\n```\n\n| App       | URL                                            |\n| --------- | ---------------------------------------------- |\n| API       | [http://localhost:3000](http://localhost:3000) |\n| Dashboard | [http://localhost:3001](http://localhost:3001) |\n| Site      | [http://localhost:3002](http://localhost:3002) |\n| Docs      | [http://localhost:3003](http://localhost:3003) |\n\n### Useful Commands\n\n| Command            | Description                       |\n| ------------------ | --------------------------------- |\n| `vp run dev`       | Start all services                |\n| `vp run build`     | Build for production              |\n| `vp run check`     | Run format, lint, and type checks |\n| `vp run test`      | Run the test suite                |\n| `vp run db:studio` | Open Drizzle Studio               |\n\n## Contributors\n\n\u003ca href=\"https://github.com/mahou-labs/shiru/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=mahou-labs/shiru\" /\u003e\n\u003c/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmahou-labs%2Fshiru","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmahou-labs%2Fshiru","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmahou-labs%2Fshiru/lists"}