create-rena-cleanarch
v1.0.3
Published
Scaffold a new project from crosbydoo/rena-cleanarch
Maintainers
Readme
create-rena-cleanarch
A CLI tool to scaffold new React Native projects using the clean architecture template from crosbydoo/rena-cleanarch.
Installation
Quick Start (Recommended)
Use npx to run the CLI without installing it globally:
npx create-rena-cleanarch <project-name>Global Installation
Install it globally via npm:
npm install -g cli-rena-cleanarchThen use it as:
create-rena-cleanarch <project-name>Local Installation
You can also install it as a dev dependency in your project:
npm install --save-dev cli-rena-cleanarchUsage
Basic Usage
Create a new project:
npx create-rena-cleanarch my-appThis will:
- Download the latest template from the rena-cleanarch repository
- Extract and copy files to your project directory
- Patch project metadata (package.json, app.json)
After the project is created, you need to install dependencies manually:
cd my-app
npm install
# or
yarn install
# or
pnpm installHelp
View usage information:
npx create-rena-cleanarch --help
# or
npx create-rena-cleanarch -hRequirements
- Node.js >= 18.0.0
- npm, yarn, or pnpm (for installing dependencies manually after project creation)
Features
- 🚀 Quick project scaffolding from a clean architecture template
- 🎯 Automatic project name patching in package.json and app.json
- 🧹 Removes template's git history for a fresh start
- 🔄 Handles redirects when downloading the template
- 📝 Manual dependency installation (you control when and how to install)
How It Works
- Download: Fetches the latest template tarball from GitHub
- Extract: Extracts the template to a temporary directory
- Copy: Copies all files to your target project directory
- Patch: Updates project metadata (name, slug, etc.)
After the project is created, you'll need to install dependencies manually using your preferred package manager (npm, yarn, or pnpm).
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT © ristudev
Related
- rena-cleanarch - The React Native clean architecture template
