Skip to content

toprakdeviren/toprak-run

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

@toprakdeviren/run

πŸ”₯ Zero-config UI starter kit with TailwindCSS + Eleventy + Vanilla JS/TS

A modern, lightning-fast project generator that builds beautiful web projects in seconds.

✨ Features

  • 🎨 TailwindCSS - Modern utility-first CSS framework
  • ⚑ Eleventy - Fast static site generator
  • πŸ”· TypeScript Support - Optional TypeScript integration
  • πŸ“± Responsive Design - Mobile-first approach
  • πŸš€ Zero Configuration - Works out of the box
  • πŸ“¦ Smart Package Manager Detection - Supports npm, yarn, and pnpm
  • 🌐 Git Integration - Optional Git repository initialization
  • πŸ”§ Modern Tooling - ESBuild, PostCSS, Autoprefixer

πŸš€ Quick Start

# Using npx (recommended)
npx @toprakdeviren/run my-project

# Or install globally
npm install -g @toprakdeviren/run
toprak-run my-project

πŸ“‹ Interactive Setup

The tool will guide you through:

  • πŸ“ Project name - Your project identifier
  • πŸ”· TypeScript - Enable TypeScript support (default: Yes)
  • 🎨 CSS Framework - Choose TailwindCSS or Plain CSS (default: TailwindCSS)
  • πŸ“¦ Git Repository - Initialize Git repo with optional remote (default: Yes)

πŸ› οΈ Generated Project Structure

my-project/
β”œβ”€β”€ package.json
β”œβ”€β”€ .eleventy.js
β”œβ”€β”€ README.md
β”œβ”€β”€ config/
β”‚   β”œβ”€β”€ tailwind.config.js
β”‚   └── postcss.config.js
|   └── eleventy.config.js
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ index.html
β”‚   β”œβ”€β”€ pages/
β”‚   β”‚   └── about.html
β”‚   β”œβ”€β”€ styles/
β”‚   β”‚   └── input.css
β”‚   └── scripts/
β”‚       └── main.js|ts
└── public/
    └── (static assets)

πŸ“ Available Scripts

# Development server with hot reload
npm run dev

# Build for production
npm run build

# Individual build commands
npm run build:css    # Build CSS
npm run build:js     # Build JavaScript
npm run build:html   # Build HTML

🎯 What You Get

  • Modern Web Stack - Latest tools and best practices
  • Responsive Layout - Mobile-first design system
  • Fast Development - Hot reload and watch mode
  • Production Ready - Optimized builds with minification
  • SEO Friendly - Clean HTML structure and meta tags
  • Accessible - WCAG compliant markup

πŸ”§ Requirements

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

πŸ“– Usage Examples

# Build a TypeScript project with TailwindCSS
npx @toprakdeviren/run my-app

# Build with verbose output
npx @toprakdeviren/run my-app --verbose

# Skip interactive prompts (use defaults)
npx @toprakdeviren/run my-app --yes

🎨 CSS Frameworks

TailwindCSS (Recommended)

  • Utility-first CSS framework
  • Highly customizable
  • Production build optimization
  • JIT compilation

Plain CSS

  • Standard CSS setup
  • PostCSS with Autoprefixer
  • Custom styling freedom

πŸš€ Deployment

Your generated project is ready for deployment to:

  • Netlify - Drag & drop dist folder
  • Vercel - Connect Git repository
  • GitHub Pages - Enable in repository settings
  • Any Static Host - Upload dist folder contents

🀝 Contributing

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

  1. Fork the repository
  2. Make your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

MIT © Uğur Toprakdeviren

πŸ”— Links


Made with ❀️ by @toprakdeviren

Build something amazing! ✨

About

Zero-config UI starter kit with TailwindCSS + Eleventy + Vanilla JS/TS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published