Repository files navigation

pzr simplifies the process of creating new pages, routes, and components, allowing developers to focus on writing business logic rather than boilerplate code.

• 🔮Smart Project Config Detection: Automatically identifies your project type and configuration
• ⚡Lightning-Fast Setup: Initialize new projects or add pzr to existing ones with a single command
• 🏗️Effortless Scaffolding: Generate pages, routes, and components tailored to your project structure
• 🔧Flexible and Customizable: Easily adjust detected settings to match your specific needs
• 🌟Framework Agnostic: Supports Next.js, Express.js, and Vite React out of the box

Whether you're a seasoned developer or just starting out, pzr helps you focus on what matters most - writing great code and building amazing applications!

• Installation
• Usage
  • Initializing a Project
  • Generating Files
• Project-Specific Usage
• Features
• Configuration
• Support
• License

Installpzr globally usingnpm oryarn:

npm install -g pzr# oryarn global add pzr

To initialize a new project or configure pzr for an existing project:

pzr init

This command will:

1. 🔍 Automatically detect your project type and configuration
2. 🖥️ Display the detected settings
3. ✅ Prompt you to confirm or modify these settings

Create new pages, routes, or components using thecreate command or its shorthand-c:

pzr create [pages...]# orpzr -c [pages...]

Create multiple pages:

pzr create home about contact# orpzr -c home about contact

Generate files in a specific directory:

pzr create -d dashboard/settings profile# orpzr -c -d dashboard/settings profile

If you prefer not to installpzr globally, use it on a per-project basis:

1. Install as a dev dependency:

   npm install --save-dev pzr# oryarn add --dev pzr

2. Runpzr commands usingnpx:

   npx pzr initnpx pzr -c home about

3. Alternatively, add scripts to yourpackage.json:

   {"scripts": {"pzr:init":"pzr init","pzr:create":"pzr -c"  }}

   Then usenpm or yarn to run the commands:

   npm run pzr:initnpm run pzr:create home about# or with yarnyarn pzr:inityarn pzr:create home about

Usepzr without installation via npx:

npx pzr initnpx pzr -c home aboutnpx pzr -c -d dashboard/settings profile

pzr intelligently detects:

• Project Type: Next.js, Express.js, or Vite React
• Language: TypeScript or JavaScript
• Source Directory: Whether you're using asrc directory
• Next.js Routing: Page Router or App Router (for Next.js projects)

After detection,pzr will display the detected settings and prompt you to confirm or customize them, ensuring accuracy and flexibility.

pzr file generation based on the project type:

• Next.js:

  • Generateslayout.tsx,page.tsx, andloader.tsx in created routes in/app or/src/app dir.
  • Supports both Page Router and App Router structures and bothtsx andjsx components.

• Express.js:

  • Creates models, controllers, and routes forjs orts apps.
  • Automatically addsapp.use(routeMiddleware) inapp.ts

• Vite React:

  • Generates.jsx or.tsx components in the/components directory

pzr stores its configuration in a.pzr-config.json file in your project root. This file is created when you runpzr init and contains information about your project type, language preference, and other settings.

For bug reports and feature requests, please open an issue on ourGitHub repository.

pzr is released under the MIT License. See the LICENSE file for more details.