Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-tigra) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

create-tigra

Generate a production-ready, robust API server in seconds.

create-tigra scaffolds a modern, high-performance backend with built-in best practices, simplifying the setup of complex stacks so you can focus on building features.

Key Features

Production-Ready Server: A robust Fastify + TypeScript foundation designed for scale and performance.
Built-in Database & Caching: Pre-configured Database (MySQL via Prisma) and Redis for caching and queues.
Docker Integration: Full docker-compose setup included. Spin up your infrastructure (Database, Redis) instantly.
Management UIs Included: Comes with containerized UIs for your database and Redis, making local development and debugging effortless.
Secured Authentication: Implementation of robust authentication strategies out-of-the-box.
RBAC & Admin Routes: Pre-built Role-Based Access Control system with dedicated, secured admin routes to manage your application.

Prerequisites

Before using create-tigra, ensure you have the following installed:

Node.js: Version 18.0.0 or higher.
Docker Desktop: Required to run the initialized project (provides MySQL, Redis, and admin UIs).
npm (or pnpm/yarn): To install dependencies.

Usage

To create a new project, simply run:

npx create-tigra <project-name>

Follow the interactive prompts to configure your new server.

What's Inside?

When you generate a project with create-tigra, you get a fully structured codebase:

Framework: Fastify (v4+)
Language: TypeScript (Strict mode)
ORM: Prisma
Validation: Zod (Type-safe schemas)
Testing: Vitest
Documentation: Swagger / OpenAPI (automatically generated)
Infrastructure: Docker Compose for MySQL, Redis, and administration UIs.

Getting Started

Generate the project:
```
npx create-tigra my-app
```
Install Dependencies:
```
cd my-app/server
npm install
```
Start Infrastructure: Make sure Docker is running, then start the services:
```
docker-compose up -d
```
Initialize Database: This command waits for the database to be ready and runs migrations:
```
npm run db:init
```
Seed Database (Optional): Populate the database with an admin user and sample data:
```
npm run prisma:seed
```
Build and Start:
```
npm run build
npm run dev
```
Your server will be running at http://localhost:3000.

License

MIT