/dyan

๐Ÿ› ๏ธ Visual API builder that lets you create, test, and self-host dynamic REST APIs โ€” without writing boilerplate code.

Primary LanguageTypeScriptMIT LicenseMIT

Dyan Logo

Dyan

Visually build, test, and deploy REST APIs without backend boilerplate
๐ŸŒ dyan.live


๐Ÿ”ฅ Key Features

  • ๐Ÿงฑ Visual REST API builder
  • โš™๏ธ Supports GET, POST, PUT, DELETE
  • โœ๏ธ Write endpoint logic in JavaScript (Python support coming soon)
  • โšก Instant test mode with live input/output
  • ๐Ÿงช Validate logic before execution
  • ๐Ÿ’ป Self-hosted & open-source

๐ŸŽฅ Demo Video

Watch the demo

Watch how Dyan lets you build, test, and run APIs in seconds with no backend boilerplate.


๐Ÿš€ Getting Started

Choose your preferred setup method:

Option 1: ๐Ÿณ Docker (Recommended)

The fastest way to get Dyan running with production-ready containers.

Prerequisites

1. Clone the repo

git clone https://github.com/dyan-dev/dyan.git
cd dyan

2. Set up environment variables

Create a .env file in the project root:

# .env
JWT_SECRET=your_super_secret_jwt_key
VITE_API_URL=http://backend:3000

3. Build and run

docker compose up --build

That's it! ๐Ÿš€ Visit http://localhost:5173 to start building your APIs.

Managing Docker setup

# Stop services
docker compose down

# Remove all data (including database)
docker compose down -v

Option 2: ๐Ÿ› ๏ธ Local Development

For contributors or those who want to modify the source code.

1. Clone the repo

git clone https://github.com/dyan-dev/dyan.git
cd dyan

2. Install dependencies

Make sure you have pnpm installed.

pnpm install

3. Set up your environment

cp .env.example .env

To skip email sending in development:

EMAIL_MOCK=true

Note: The magic link will be printed on console of backend.

4. Run backend and frontend

In the root folder, run:

# Start the frontend (localhost:5173)
pnpm --filter frontend dev

# Start the backend (localhost:3000)
pnpm --filter backend exec prisma generate
pnpm --filter backend exec prisma migrate deploy
pnpm --filter backend dev

Visit http://localhost:5173 to start building your APIs.


๐Ÿ“ฆ Architecture

  • Frontend: React + Tailwind CSS
  • Backend: NestJS (TypeScript)
  • Sandbox Runtime: Secure execution via vm2
  • Database: Local SQLite (PostgreSQL/MySQL support planned)

๐Ÿ’ก Example Use Cases

  • Build and test REST APIs visually โ€” no backend required
  • Quickly prototype business logic for internal tools
  • Share and collaborate on API logic
  • Host a lightweight backend API layer in seconds

๐Ÿงช Project Status

This is an early-stage project in active development.

  • โœ… Supports: GET, POST, PUT, DELETE
  • โœจ JavaScript logic + runtime
  • ๐Ÿงช Input/output testing panel
  • โณ Python support coming soon
  • ๐Ÿ’ฌ Community contributions welcome!

๐Ÿค Contributing

We welcome issues, feature ideas, and PRs from the community.

Start with good first issue tags or join our Discord to chat and collaborate.


๐Ÿ“„ License

MIT ยฉ Dyan Dev