create-fastpress

Official CLI tool for FastPress - The simple and fast backend framework for building backend applications with TypeScript and Prisma.

🚀 Quick Start

Create a new FastPress project in seconds:

npx create-fastpress

That's it! The CLI will guide you through the setup process interactively.

✨ Features

• 🎯 Interactive CLI - User-friendly prompts guide you through project setup
• 🗄️ Database Adapter Selection - Choose from PostgreSQL, MySQL/MariaDB, or SQLite
• 📦 Ready-to-use Template - Complete project structure with best practices
• ⚡ Quick Setup - Get started in seconds with sensible defaults
• 🔧 Pre-configured - Prisma, TypeScript, and FastPress configured out of the box

📋 Prerequisites

• Node.js >= 18.0.0
• npm, pnpm, or yarn

🎨 What You'll Get

Running npx create-fastpress will create a new project with:

• ✅ Complete FastPress project structure
• ✅ TypeScript configuration
• ✅ Prisma ORM setup with your chosen database adapter
• ✅ Sample module (controller, service, and Zod schemas)
• ✅ Environment variables template (.env)
• ✅ FastPress configuration file
• ✅ Ready-to-use scripts (dev, build, setup)

🛠️ Usage

Interactive Mode (Recommended)

Simply run:

npx create-fastpress

The CLI will prompt you for:

1. Project name - Your new project directory name
2. Database adapter - Choose your preferred database:
   • PostgreSQL
   • MySQL/MariaDB
   • SQLite
   • Skip adapter setup (configure later)

Next Steps

After creating your project:

# 1. Navigate to your project
cd your-project-name

# 2. Install dependencies
npm install

# 3. Configure your database connection in .env file
# (Already templated with sensible defaults)

# 4. Run database setup
npm run setup

# 5. Start development server
npm run dev

Your FastPress API will be running! 🎉

📚 Documentation

For more information about FastPress framework:

• NPM Package: @cristianrg/fastpress
• GitHub: FastPress Repository

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Created with 💙 by Cristian Alexander Rizo Gómez

• GitHub: @CristianRG

⭐ Support

If you find this project useful, please consider giving it a star on GitHub!