https://github.com/mahou-labs/shiru
The OSS documentation platform
https://github.com/mahou-labs/shiru
agents ai documentation mcp robots-txt
Last synced: 3 months ago
JSON representation
The OSS documentation platform
- Host: GitHub
- URL: https://github.com/mahou-labs/shiru
- Owner: mahou-labs
- License: other
- Created: 2026-03-12T14:11:39.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-07T20:16:52.000Z (3 months ago)
- Last Synced: 2026-04-07T20:27:33.641Z (3 months ago)
- Topics: agents, ai, documentation, mcp, robots-txt
- Language: TypeScript
- Homepage: https://shiru.sh
- Size: 3.42 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
Shiru
Shiru 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.
## Tech Stack
- **Monorepo**: Turborepo + Bun
- **Frontend**: React 19 + TanStack Router (SPA) + TailwindCSS v4
- **Backend**: Hono + oRPC (type-safe APIs)
- **Auth**: Better Auth (with organization plugin)
- **Database**: Drizzle ORM
- **Billing**: Polar
- **Linting/Formatting**: OxLint + OxFmt
- **UI**: Shared `@shiru/ui` component library (Base UI + CVA)
## Running Locally
### Prerequisites
- [Bun](https://bun.sh/) (v1.0+)
- [Docker](https://www.docker.com/) (for PostgreSQL)
### Setup
1. Clone the repository and install dependencies:
```bash
git clone https://github.com/mahou-labs/shiru.git
cd shiru
vp install
```
2. Start the PostgreSQL database:
```bash
vp run db:start
```
3. Copy the environment files and configure them:
```bash
cp apps/api/.env.example apps/api/.env
cp apps/dashboard/.env.example apps/dashboard/.env
```
4. Push the database schema:
```bash
vp run db:push
```
5. Start the development servers:
```bash
vp run dev
```
| App | URL |
| --------- | ---------------------------------------------- |
| API | [http://localhost:3000](http://localhost:3000) |
| Dashboard | [http://localhost:3001](http://localhost:3001) |
| Site | [http://localhost:3002](http://localhost:3002) |
| Docs | [http://localhost:3003](http://localhost:3003) |
### Useful Commands
| Command | Description |
| ------------------ | --------------------------------- |
| `vp run dev` | Start all services |
| `vp run build` | Build for production |
| `vp run check` | Run format, lint, and type checks |
| `vp run test` | Run the test suite |
| `vp run db:studio` | Open Drizzle Studio |
## Contributors
