Introduction

What is PEST.js?

PEST.js is a CLI tool that generates production-ready Node.js applications with Express.js, TypeScript, and essential configurations.

What PEST.js Generates

• Express.js Application: Basic server setup with routes
• TypeScript Configuration: Strict type checking and compilation
• ESLint Setup: Code quality and consistency
• Jest Testing: Unit and integration testing
• Git Repository: Automatic initialization
• Environment Files: Basic configuration

Generated Project Structure

your-project/
├── src/
│   ├── app.ts           # Main Express application
│   ├── config/          # Configuration files
│   ├── features/        # Feature modules
│   ├── middleware/      # Custom middleware
│   ├── utils/           # Utility functions
│   └── types/           # TypeScript types
├── tests/               # Test files
├── package.json         # Dependencies and scripts
├── tsconfig.json        # TypeScript configuration
├── .eslintrc.json       # ESLint configuration
└── .env                 # Environment variables

Dependencies Included

Core Dependencies

• express - Web framework
• cors - Cross-origin resource sharing
• helmet - Security headers
• dotenv - Environment variables

Development Dependencies

• typescript - Type safety
• jest - Testing framework
• eslint - Code linting
• nodemon - Development server

Quick Start

# Run the framework
./pestjs

# Follow prompts
# Navigate to project
cd your-project-name

# Install dependencies
npm install

# Start development
npm run dev

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm start - Start production server
• npm test - Run tests
• npm run lint - Run ESLint