@enfyra/create-app
v0.1.38
Published
Create Enfyra frontend applications with ease
Maintainers
Readme
Create Enfyra App
🚀 The fastest way to create new Enfyra frontend applications
Create Enfyra App is a CLI tool that instantly scaffolds new Enfyra frontend projects with all the essentials configured for you.
⚠️ Prerequisites
Important: You need to have an Enfyra backend running before creating your frontend application. The frontend will connect to your backend API.
📋 Set up your backend first:
npx @enfyra/create-server my-backend👉 Backend Setup Guide - Complete instructions for setting up your Enfyra backend
The frontend does not own backend secrets. For self-hosted backends, keep the server SECRET_KEY stable and backed up because it signs auth tokens and decrypts fields marked isEncrypted=true.
Quick Start
# Using npx (recommended)
npx @enfyra/create-app
# Using yarn
yarn create @enfyra/app
# Using pnpm
pnpm create @enfyra/app
# Or install globally
npm install -g @enfyra/create-app
create-appDemo
🌐 Live Demo: https://demo.enfyra.io
What You Get
✅ Nuxt 3 application ready to go
✅ Enfyra SDK pre-configured
✅ TypeScript support
✅ Tailwind CSS styling
✅ Database support - MongoDB, PostgreSQL, MySQL
✅ Environment variables setup
✅ Dependencies installed automatically
Requirements
- Node.js 20.0.0 or higher
- Package manager: npm (8+), yarn (1.22+), pnpm (7+), or bun (1+)
Usage
Create a new project
npx @enfyra/create-app
# Optional: specify a name
npx @enfyra/create-app my-enfyra-appInteractive setup
The CLI will guide you through:
- Package manager selection (npm, yarn, pnpm)
- Database type selection (MongoDB, PostgreSQL, MySQL)
- API endpoint configuration
- Development port setup
Database Support
Choose from multiple database options during setup:
- 🍃 MongoDB - NoSQL document database
- 🐘 PostgreSQL - Powerful relational database
- 🐬 MySQL - Popular relational database
The selected database type will be automatically configured in your .env file.
Environment Variables
After project creation, you can modify the .env file at any time to configure:
- API endpoints
- Port
- Database type
The .env file is automatically created and can be customized for your specific needs.
Start developing
cd my-project
npm run devAfter Installation
Your new Enfyra app is ready! Here's what to do next:
Development
npm run dev # Start development server
npm run build # Build for production
npm run preview # Preview production buildLearn More
📖 Complete Documentation - Full guide to building with Enfyra
🔧 Installation Guide - Backend and frontend setup
🎨 App Documentation - Frontend application template
Support
Having issues? We're here to help:
Related
- Enfyra App - The frontend template
- Enfyra Server - Backend framework
- Create Enfyra Server - Backend CLI
Built by Enfyra Team • MIT License
