Skip to content

Latest commit

 

History

History
147 lines (104 loc) · 4 KB

README.md

File metadata and controls

147 lines (104 loc) · 4 KB

🌟 Create Nolly CLI

Version Downloads License Stars Last Commit

Create Nolly CLI is a modern toolkit for bootstrapping web projects with minimal effort. 🚀 It offers preconfigured templates for Frontend, Backend, and Fullstack projects to help you focus on building, not configuring.

✨ Features

  • 🛠️ Ready-to-Use Templates: Vite + React, Express, or both!
  • ⚡ Quick Setup: Organized and production-ready project structures.
  • 🌈 Developer-Friendly CLI: Interactive prompts, rich visuals, and helpful outputs.
  • 📦 Supports npm, pnpm, or yarn.
  • 📚 Comprehensive Documentation: Includes inline guidance and a detailed Wiki.

🔥 Getting Started

🧑‍💻 Installation

Install globally via npm:

npm install -g nolly-cli

🎉 Usage

Create a new project with one command:

create-nolly new

Follow the interactive prompts or use optional flags to:

  1. Choose a template:
    • Frontend (Vite + React + TypeScript + SASS)
    • Backend (Express + TypeScript)
    • Fullstack (Frontend + Backend)
  2. Customize your project name or use the default.
  3. [Optional] Skip prompts by providing:
    • --package-manager <manager>: Specify npm, pnpm, or yarn.
    • --no-git: Skip Git initialization.
    • --no-install: Skip installing dependencies.

📦 Available Templates

Frontend

  • ⚡ Vite: Super-fast build tool.
  • ⚛️ React: Modern UI library.
  • 🎨 SASS: Robust styling with preprocessor.
  • 🔒 TypeScript: Static typing for scalability.

Backend

  • 🚀 Express: Lightweight and fast web framework.
  • 🛡️ Middleware: Preconfigured with CORS, Helmet, and more.
  • 🔒 TypeScript: Type-safe and maintainable backend setup.

Fullstack

  • Combines Frontend and Backend seamlessly.
  • Preconfigured for integration between React and Express.

📚 Learn More

Visit the Wiki for:

  • Full tutorials for each template.
  • Deployment guides.
  • Advanced CLI usage.

🛠️ Example Outputs

Frontend Project

🎉 Project 'my-frontend' created successfully!
📦 Next steps:
1. Navigate to your project folder: cd my-frontend
2. Install dependencies: npm install
3. Start the dev server: npm run dev

Backend Project

🎉 Project 'my-backend' created successfully!
📦 Next steps:
1. Navigate to your project folder: cd my-backend
2. Install dependencies: npm install
3. Start the server: npm run dev

⚠️ Requirements

Ensure your environment meets these requirements:

  • Node.js v18 or later (for compatibility and stability).
  • A package manager (npm, pnpm, or yarn) installed globally.
  • Optional: Run create-nolly --help for quick reference to commands.

💬 Support

Need help or have feedback?

❤️ Contributors

A big thanks to all contributors!

🛡️ License

This project is licensed under the MIT License.

☕ Support Me

Made with ❤️ by Nolly for Nolly's Cafe.