create-raclette-app

A CLI tool to quickly scaffold new raclette applications - the framework for building platforms and portals faster than ever.

What is raclette?

raclette is a full-stack TypeScript meta-framework designed for building platforms and portals with minimal setup. It comes with bootstrapped features like authentication, WebSockets, database handling, containerization, and provides an easy-to-use, opinionated environment.

Perfect for:

• 🚀 SaaS platforms - Get to market faster with built-in auth and user management
• 🏢 Customer/Supplier portals - Enterprise-ready from day one
• 🛠️ Internal business tools - Focus on business logic, not infrastructure
• ⚡ MVPs that can scale - Start fast, grow clean with the plugin architecture

Key Features:

• Widget-based frontend (Vue.js + Vite, React support coming)
• Plugin architecture for reusable business logic
• Built-in workbench - Admin interface out of the box
• Full-stack development with Fastify backend + MongoDB
• Docker containerization for easy deployment

Usage

Interactive Mode (Recommended)

npx create-raclette-app

Quick Start with Project Name

npx create-raclette-app my-awesome-platform

Create in Current Directory

mkdir my-project && cd my-project
npx create-raclette-app .

Non-Interactive Mode

npx create-raclette-app my-platform --non-interactive

Wizard Questions

The interactive wizard will ask you:

1. Project name - Used for folder name (converted to kebab-case) and configuration
2. ESLint configuration - Choose between standard or recommended (opinionated) config

What You Get

• ✅ raclette core & workbench dependencies with dev dependencies
• ✅ raclette.config.js - Main configuration file
• ✅ Development scripts ready to go
• ✅ ESLint + Prettier configuration
• ✅ TypeScript setup
• ✅ Docker-ready development environment

Getting Started

After running the CLI:

cd your-project-name
yarn install
yarn dev

⏳ First start note: The initial yarn dev might take a few minutes as Docker containers are built and started.

Once running, you'll have:

• Your app frontend: http://localhost:8081
• raclette workbench: http://localhost:8083

Important: Visit the workbench first (http://localhost:8083) to create your admin user before accessing the main app.

Next Steps

1. Create your admin user in the workbench
2. Explore the documentation: docs.raclettejs.com
3. Start building your platform with plugins and widgets!

Troubleshooting

Having Docker issues? Check the troubleshooting guide in our documentation.

Requirements

• Node.js 24+ (might work with lower versions as well)
• yarn (for raclette)
• npm (for npx)
• Docker (for development environment)

Links

• 🌐 Website
• 📚 Documentation
• 🚀 GitLab (source code)
• 📦 npm (packages)

License

MIT

Stop building from scratch. Start with raclette. 🧀