ts-aiagent-boilerplate is a TypeScript-based boilerplate designed to help developers quickly start developing custom modules and packages for @ai16zdao's Eliza framework. It provides a robust development environment with tools for linting, formatting, testing, and building scalable Node.js applications. This project is not a fork of the Eliza codebase, and is instead a complementary starting point for module and package development that follows the same practices as the core project.
- TypeScript-first Development: Type-safe and scalable codebase.
- ESLint and Prettier: Enforce consistent code quality and formatting.
- Vitest Integration: Fast and modern testing framework.
- PNPM for Dependency Management: Faster, more efficient package management.
- Configurable Build System: Ready for production deployment.
- Node.js 22+ (Use NVM for version management)
- PNPM (Install via
npm install -g pnpm)
-
Clone the repository:
git clone https://github.com/yourusername/ts-aiagent-boilerplate.git cd ts-aiagent-boilerplate -
Install dependencies:
pnpm install
-
Run tests:
pnpm test -
Lint the code:
pnpm lint
-
Build the project:
pnpm build
-
Start the project (for testing purposes):
node dist/index.js
ts-aiagent-boilerplate/
├── src/ # Source code
│ ├── index.ts # Entry point
│ ├── core/ # Core modules
│ ├── utils/ # Utility functions
├── test/ # Unit tests
├── config/ # Configuration files
├── dist/ # Compiled output
├── scripts/ # Helper scripts (build, clean, etc.)
├── package.json # Project metadata and dependencies
├── tsconfig.json # TypeScript configuration
├── .eslintrc.mjs # ESLint configuration
├── .prettierrc # Prettier configuration
├── .gitignore # Ignored files
└── README.md # Project documentation
This boilerplate is inspired by @ai16zdao's Eliza framework, a powerful foundation for developing #aiagents.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or feedback, please reach out to @cottenio.