create-stb

Serverless TypeScript Boilerplate by Sam Newhouse

A CLI to instantly scaffold a production-ready Serverless TypeScript Boilerplate.

---

🚀 Features

• Fast Setup - Scaffold a complete serverless app in seconds
• TypeScript Ready - Full TypeScript support with AWS Lambda and DynamoDB
• Zero Config - Automatically updates project name and installs dependencies
• Production Ready - Includes all configs, sample handlers, and best practices
• Local Development - Docker Compose setup for local DynamoDB testing
• Modern Stack - Node.js 20.x, Serverless Framework, and AWS services

---

📦 Quick Start

Using npx (Recommended)

npx create-stb my-app

Global Installation

npm install -g create-stb
create-stb my-app

---

🛠 Usage

npx create-stb <project-name>

This creates a new directory with your project name in the current folder.

Example

npx create-stb <project-name>
cd pineapple-api
npm run offline

Your serverless API will be running at http://localhost:3000

---

🧩 What's Included

Project Structure

• ✅ Serverless Configuration - Pre-configured serverless.yml for AWS Lambda
• ✅ TypeScript Setup - Ready-to-use TypeScript configuration
• ✅ DynamoDB Integration - Local DynamoDB with Docker Compose
• ✅ Sample Handlers - Example Lambda functions to get started
• ✅ Development Scripts - offline, build, deploy commands
• ✅ Code Quality - Prettier configuration for consistent formatting
• ✅ Environment Config - .env.example for environment variables

Tech Stack

• Runtime: Node.js 20.x
• Language: TypeScript
• Framework: Serverless Framework
• Cloud: AWS (Lambda, DynamoDB, API Gateway)
• Local Dev: serverless-offline, Docker

---

📋 Requirements

• Node.js >= 20.0.0
• npm >= 10.0.0
• Git (for cloning the template)

---

🔗 Links

• GitHub Repository
• NPM Package
• Report Issues
• Template Repository

---

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

See CONTRIBUTING.md for details.

---

📄 License

MIT © Sam Newhouse

---

💖 Support

If you find this tool helpful, please consider:

• ⭐ Starring the repository
• 🐛 Reporting issues
• 💬 Sharing feedback and suggestions

Thank you for using create-stb! 🚀