@trapar-waves/llm-template/README.md

A template for LLM development integrating AI tools, TypeScript, Zod validation, and development utilities like Vitest and Rslib.

# @trapar-waves/llm-template

![npm version](https://img.shields.io/npm/v/@trapar-waves/llm-template)
![npm dm](https://img.shields.io/npm/dm/@trapar-waves/llm-template)
![License](https://img.shields.io/github/license/Trapar-waves/llm-template)
![GitHub last commit](https://img.shields.io/github/last-commit/Trapar-waves/llm-template)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Trapar-waves/llm-template/release.yml)
![Renovate](https://img.shields.io/badge/renovate-enabled-blue)

---

[中文](/readme/README-CN.md) | [日本語](/readme/README-JP.md) | [Русский язык](/readme/README-RU.md)

> A production-ready template for LLM (Large Language Model) application development, integrating AI tools, TypeScript type safety, Zod validation, and modern dev utilities.

## ✨ Features

- **Type Safety:** Powered by TypeScript for compile-time type checking and enhanced code maintainability.
- **Runtime Validation:** Zod schema validation ensures data integrity across API endpoints and model interactions.
- **Rapid Development:** Vite-based dev server with HMR (Hot Module Replacement) for instant feedback during iteration.
- **Test-Driven:** Vitest integrated for fast unit testing, ensuring code reliability from development to production.
- **AI-Ready:** Pre-configured with AI SDKs (`@ai-sdk/openai`, `ai`) for seamless LLM integration and workflow automation.
- **Cross-Platform Paths:** `pathe` for consistent path handling across Windows/macOS/Linux environments.
- **Code Consistency:** Prettier formatting and Antfu's ESLint rules enforce standardized code style.
- **Environment Management:** `dotenv` for secure configuration of API keys and environment-specific settings.

## 💻 Tech Stack

- **Development:** Provides TypeScript language support, Vite development server, and Rslib build tooling for strict type checking, fast hot module replacement, and optimized production builds.
- **AI Integration:** Integrates OpenAI API client and AI workflow utilities to support large language model interactions and AI-driven feature development.
- **Validation & Quality:** Includes Zod runtime schema validation, ESLint code quality enforcement, and Prettier formatting tools to ensure code integrity and consistency.
- **Development:** Contains Vitest testing framework, Pathe path manipulation, Dotenv environment variable management, and other development utilities to support comprehensive project requirements.

See the [package.json](package.json) for a full list of dependencies.

## 🚀 Getting Started

Follow these instructions to get the project running locally.

### Prerequisites

Ensure you have the following installed:

- Node.js (>= 18.x recommended)
- Package manager (npm, yarn, or pnpm)

```bash
node -v
npm -v
```

### Installation

Run script

```bash
pnpm create trapar-waves
```

Install dependencies

```bash
npm install
yarn install
pnpm install
```

## 🤝 Contributing

Contributions are welcome and greatly appreciated! Please follow these steps to contribute:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 👤 Author

- **Rikka:** (admin@rikka.cc)
- **GitHub Profile:** [Muromi-Rikka](https://github.com/Muromi-Rikka)

## 🔗 Links

- **Repository:** [https://github.com/Trapar-waves/llm-template](https://github.com/Trapar-waves/llm-template)
- **Homepage:** [https://github.com/Trapar-waves/llm-template](https://github.com/Trapar-waves/llm-template)
- **Issues:** [https://github.com/Trapar-waves/llm-template/issues](https://github.com/Trapar-waves/llm-template/issues)