@hongshanx/horadrim

A frontend scaffolding tool that creates projects.

Prerequisites

• Node.js (v20 or higher recommended)

Usage

# Navigate to the directory where you want to create your project
cd my-projects-folder

# Create a new project (no installation required)
npx @hongshanx/horadrim create

# Follow the prompts to create your project
# 1. Enter a project name
# 2. Choose whether to create the project in the current directory or a new directory
# 3. If the directory is not empty, choose to overwrite existing files, clear the directory, or cancel
# 4. Select a project template
# 5. The tool will scaffold your project

# After project creation, you can start development with:
npm install
npm run dev

Features

• Interactive CLI
• Automatic project setup
• Multiple project templates
• TypeScript support

Available Templates

Currently, the following templates are available:

• React: React Single Page Application with TypeScript

Adding New Templates

To add a new template:

1. Create a new directory in the templates folder with your template name
2. Add the necessary template files to this directory
3. Update src/templates.ts to include your new template:

export const templates: Template[] = [
  // Existing templates...
  {
    name: "Your Template Name",
    dir: "your-template-directory-name",
    description: "Description of your template",
  },
];