0.1.3 • Published 7 months ago

create-liteflow v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Create LiteFlow

The easiest way to get started with LiteFlow - a modern, lightweight web framework.

Usage

# Using npm
npx create-liteflow my-app

# Using yarn
yarn create liteflow my-app

# Using pnpm
pnpm create liteflow my-app

Features

  • šŸš€ Quick Start: Set up a new LiteFlow project in seconds
  • šŸ“¦ Multiple Templates: Choose from Basic, Enterprise, or E-commerce templates
  • šŸŽØ Pre-configured UI: Built-in UI components using Radix UI and Tailwind CSS
  • šŸ”’ Type Safety: Full TypeScript support out of the box
  • āš”ļø Fast Development: Powered by Vite for lightning-fast development
  • šŸŽÆ Best Practices: Follows modern web development best practices

Templates

Basic Template

A simple starter template with:

  • React + TypeScript
  • Vite for development
  • Tailwind CSS for styling
  • LiteFlow UI components
  • ESLint configuration
  • Basic routing setup

Enterprise Template (Coming Soon)

A full-featured template with:

  • Advanced routing
  • State management
  • Authentication
  • API integration
  • Testing setup
  • CI/CD configuration

E-commerce Template (Coming Soon)

A complete e-commerce starter with:

  • Product catalog
  • Shopping cart
  • Checkout flow
  • Payment integration
  • Admin dashboard
  • SEO optimization

Project Structure

my-app/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ components/
│   ā”œā”€ā”€ pages/
│   ā”œā”€ā”€ App.tsx
│   └── main.tsx
ā”œā”€ā”€ public/
ā”œā”€ā”€ package.json
ā”œā”€ā”€ tsconfig.json
ā”œā”€ā”€ vite.config.ts
└── tailwind.config.js

Configuration

The generated project includes:

  • TypeScript: Pre-configured tsconfig.json
  • Vite: Optimized build settings
  • Tailwind CSS: Custom theme configuration
  • ESLint: Code quality rules
  • Prettier: Code formatting
  • LiteFlow UI: Pre-built component library

Development

# Start development server
npm run dev
# or
yarn dev
# or
pnpm dev

# Build for production
npm run build
# or
yarn build
# or
pnpm build

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT Ā© LiteFlow Team