Skip to content

typus-dev/typus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TYPUS

TypeScript full-stack app starter for building SaaS fast

License: MIT TypeScript Vue 3 Docker

DemoWebsiteYouTubeGitHub


Watch Trailer

Click to watch trailer


What is Typus?

Typus is a production-ready SaaS foundation that lets you focus on business logic while core infrastructure is already in place:

  • Authentication — JWT, OAuth, 2FA (TOTP)
  • Admin Panel — Vue 3 + TypeScript
  • Permissions — CASL roles/abilities
  • Plugin Architecture — Extend without touching core
  • Auto-generated CRUD APIs — Define model, get API
  • Database DSL — Schema-as-code

Your job: Add business logic. Everything else is ready.


Quick Start

# Clone
git clone https://github.com/typus-dev/typus.git
cd typus

# Start (zero-config localhost)
docker compose up -d --build

# Open
# http://localhost:3000
# admin@localhost / admin12345

That's it. No external database required outside Docker.


How it runs locally

By default it runs 2 containers:

  • typus_lite — nginx + backend + frontend (single app container)
  • mysql — MySQL 8.0 database (separate container)

Features

Feature Description
2 Containers (default) app + mysql (no external DB required outside Docker)
3 Profiles local (laptop), dev (server), prod (production)
DSL Models Define schema → get API, types, validation
Plugin System Add features without touching core
Real-time WebSocket events (Redis optional)
Queue System Background jobs (email/telegram handlers, etc.)

Deployment Profiles

# Local works out of the box:
./manage.sh switch local

# Dev/Prod require profile env files (they are gitignored by design):
cp .env.example .env.dev
cp .env.example .env.prod

./manage.sh switch dev
./manage.sh switch prod

Tech Stack

  • Backend: Node.js, Express, Prisma, TypeScript
  • Frontend: Vue 3, Vite, TypeScript
  • Database: MySQL 8.0 (or embedded)
  • Container: Docker, supervisord

Requirements

  • Docker & Docker Compose
  • 512MB+ RAM
  • ~500MB disk space

Documentation

Coming soon at typus.dev/docs


License

MIT License - see LICENSE for details.


Built with TypeScript, Vue 3, and lots of coffee

typus.dev

About

TypeScript full‑stack web app starter (Docker‑first, zero‑config localhost)

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages