Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adityavijay21/fleem
🚀 A powerful CLI tool for generating customizable React projects with support for TypeScript, Jest, SCSS, routing, and state management. ✨📦
https://github.com/adityavijay21/fleem
adityavijay21 cli fleem harki jest npm-package project-generator react react-automation react-boilerplate react-cli react-generator react-setup react-starter react-template scaffolding scss state-management tailwindcss typescript
Last synced: 15 days ago
JSON representation
🚀 A powerful CLI tool for generating customizable React projects with support for TypeScript, Jest, SCSS, routing, and state management. ✨📦
- Host: GitHub
- URL: https://github.com/adityavijay21/fleem
- Owner: adityavijay21
- Created: 2024-09-24T17:52:20.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-02T08:39:59.000Z (about 1 month ago)
- Last Synced: 2024-10-14T20:41:02.437Z (23 days ago)
- Topics: adityavijay21, cli, fleem, harki, jest, npm-package, project-generator, react, react-automation, react-boilerplate, react-cli, react-generator, react-setup, react-starter, react-template, scaffolding, scss, state-management, tailwindcss, typescript
- Language: JavaScript
- Homepage: https://fleem.is-a.dev/
- Size: 18.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fleem - The Ultimate React Project Generator
🚀 **Fleem** is a powerful CLI tool that allows developers to quickly scaffold React projects with customizable options like TypeScript, testing frameworks, CSS preprocessors, routing, and state management. Fleem simplifies project setup and configuration, enabling you to focus on coding.
## Features
- **TypeScript support**: Easily add TypeScript to your project.
- **Testing frameworks**: Choose between Jest, Mocha, or Chai for testing.
- **Code formatting**: Optionally integrate Prettier for code formatting.
- **CSS preprocessors**: Choose between plain CSS, SCSS, LESS, or Tailwind CSS.
- **Routing**: Add React Router for routing management.
- **State management**: Optionally integrate Redux, MobX, or Zustand for state management.
- **Git initialization**: Automatically initialize a Git repository.
- **Supports npm, yarn, and pnpm**: Select your preferred package manager.
## Installation
To install Fleem globally, run:
```bash
npm install -g fleem
```
## Usage
### Create a new React project
You can generate a new React project by running:
```bash
fleem
```
The CLI will guide you through a series of prompts to configure your project. You can also use the `--default` flag for a quick setup with default options:
```bash
fleem --default
```
### Custom Options
You can override the default configuration using various options:
- `--typescript`: Use TypeScript.
- `--jest`: Add Jest for testing.
- `--prettier`: Add Prettier for code formatting.
- `--scss`: Use SCSS for styling.
- `--routing`: Add React Router for routing.
- `--state-management `: Specify a state management tool (`redux`, `mobx`, or `zustand`).
- `--package-manager `: Specify the package manager (`npm`, `yarn`, or `pnpm`).
Example:
```bash
fleem my-app --typescript --jest --prettier --scss --routing --state-management redux
```
### Upgrade Fleem
To upgrade Fleem to the latest version, run:
```bash
fleem upgrade
```
## Contributing
We welcome contributions to Fleem! Feel free to open issues or submit pull requests on [GitHub](https://github.com/adityavijay21/fleem).
## Socials
- **Website**: [https://fleem.is-a.dev/](https://fleem.is-a.dev/)
- **NPM Package**: [https://www.npmjs.com/package/fleem](https://www.npmjs.com/package/fleem)
- **GitHub**: [https://github.com/adityavijay21/fleem](https://github.com/adityavijay21/fleem)