# TypeServe

TypeServe is the first and only tool that generates live mock APIs directly from your TypeScript types. No schema files, no OpenAPI definitions, no manual configuration—just your existing TypeScript interfaces, types, and enums.

## Key Links

- Home: https://typeserve.com
- Documentation: https://typeserve.com/docs
- GitHub: https://github.com/emmanueltaiwo/typeserve
- npm: https://www.npmjs.com/package/typeserve
- TypeServe Live (instant mock APIs): https://typeserve.live

## Documentation Sections

### Getting started

- Installation: https://typeserve.com/docs/getting-started/installation
  Install TypeServe in your project in seconds

- Introduction: https://typeserve.com/docs/getting-started/introduction
  Generate live mock APIs from your TypeScript types. No backend needed.

- Quick Start: https://typeserve.com/docs/getting-started/quick-start
  Create your first mock API in 3 simple steps

### Configuration

- Config File: https://typeserve.com/docs/configuration/config-file
  Learn how to configure TypeServe

- Configuration Options: https://typeserve.com/docs/configuration/options
  Complete reference of all TypeServe configuration options

- Routes: https://typeserve.com/docs/configuration/routes
  Configure API routes and map them to TypeScript types

### Api reference

- CLI Commands: https://typeserve.com/docs/api-reference/cli
  Complete reference for TypeServe CLI commands

- Config Reference: https://typeserve.com/docs/api-reference/config
  Complete TypeServe configuration API reference

### Features

- Hot Reload: https://typeserve.com/docs/features/hot-reload
  TypeServe automatically reloads when your types or config change

- Nested Types: https://typeserve.com/docs/features/nested-types
  TypeServe supports complex nested type structures

- Smart Data Generation: https://typeserve.com/docs/features/smart-generation
  TypeServe automatically detects field patterns and generates realistic data