Skip to content

Repository files navigation

ReadyTemp CLI 🚀

npm version License Downloads GitHub stars

ReadyTemp Logo

Create production-ready React applications in seconds! 🎯

InstallationQuick StartFeaturesTemplatesDocumentationContributing

🌟 Why ReadyTemp?

ReadyTemp is your go-to CLI tool for bootstrapping professional React applications. Stop wasting time on initial setup and focus on what matters - building great features!

✨ Key Features

  • 🎯 Multiple Project Templates

    • Base Template (Clean & Modern)
    • Todo Application (State Management)
    • Dashboard Template (Data Visualization)
  • 🛠️ Modern Tech Stack

    • React 18+ Support
    • TypeScript/JavaScript
    • Popular UI Frameworks
    • Latest Best Practices
  • 📦 Production Ready

    • Optimized Build Setup
    • Testing Configuration
    • ESLint & Prettier
    • Git Hooks with Husky
  • 🎨 UI Framework Options

    • Tailwind CSS
    • Material UI
    • Chakra UI

🚀 Quick Start

Installation

```bash

Using npm

npm install -g readytemp

Using yarn

yarn global add readytemp

Using pnpm

pnpm add -g readytemp ```

Create Your First Project

```bash readytemp create my-awesome-app ```

Follow the interactive prompts to customize your project:

  1. Choose a template
  2. Select language (JavaScript/TypeScript)
  3. Pick your UI framework
  4. Choose package manager

📚 Templates

1. Base Template

Perfect for starting fresh with a clean, modern setup:

  • Optimized folder structure
  • Routing configuration
  • Component templates
  • Basic styling setup

2. Todo Application

Learn and implement core React concepts:

  • State management patterns
  • CRUD operations
  • Local storage integration
  • Component composition

3. Dashboard Template

Build data-rich applications:

  • Chart integrations
  • Data visualization
  • Responsive layouts
  • Mock data setup

🛠️ Project Structure

``` my-awesome-app/ ├── public/ │ ├── index.html │ └── manifest.json ├── src/ │ ├── components/ │ │ ├── common/ │ │ └── layout/ │ ├── pages/ │ ├── hooks/ │ ├── context/ │ ├── utils/ │ ├── styles/ │ ├── App.tsx │ └── index.tsx ├── tests/ ├── .eslintrc.json ├── .prettierrc ├── package.json └── README.md ```

🔧 Configuration Options

Feature Options
Language JavaScript, TypeScript
UI Framework Tailwind CSS, Material UI, Chakra UI
Package Manager npm, yarn, pnpm
Linting ESLint, Prettier
Testing Jest, React Testing Library

📖 Documentation

🤝 Contributing

We love contributions! Here's how you can help:

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

See CONTRIBUTING.md for detailed guidelines.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • React Community
  • Open Source Contributors
  • Our Amazing Users

📬 Contact & Support


Made with ❤️ by Dampi Pal

If you find this project helpful, please consider giving it a ⭐️

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages