neat-admin-cli 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,25 +1,23 @@
1
- # ndc
1
+ # neat-admin-cli
2
2
 
3
- A CLI tool to scaffold an Ant Design admin project from the [ant-admin-template](https://github.com/leonwgc/ant-admin-template) GitHub template.
4
-
5
- [中文文档](./README.zh-CN.md)
3
+ A CLI tool to scaffold a Neat Design admin project
6
4
 
7
5
  ## Installation
8
6
 
9
7
  ```bash
10
- npm install -g ndc
8
+ npm install -g neat-admin-cli
11
9
  ```
12
10
 
13
11
  Or use it directly via `npx`:
14
12
 
15
13
  ```bash
16
- npx ndc init --dir my-admin-project
14
+ npx neat-admin-cli init --dir my-admin-project
17
15
  ```
18
16
 
19
17
  ## Usage
20
18
 
21
19
  ```bash
22
- ndc init --dir <directory>
20
+ neat-admin-cli init --dir <directory>
23
21
  ```
24
22
 
25
23
  ### Options
@@ -34,10 +32,10 @@ ndc init --dir <directory>
34
32
 
35
33
  ```bash
36
34
  # Create a project in the current directory
37
- ndc init --dir my-admin-project
35
+ neat-admin-cli init --dir my-admin-project
38
36
 
39
37
  # Create a project at an absolute path
40
- ndc init --dir /path/to/my-admin-project
38
+ neat-admin-cli init --dir /path/to/my-admin-project
41
39
  ```
42
40
 
43
41
  After initialization, the tool will:
@@ -50,18 +48,9 @@ Then start the development server:
50
48
 
51
49
  ```bash
52
50
  cd my-admin-project
53
- npm run dev
51
+ npm start
54
52
  ```
55
53
 
56
- ## Template
57
-
58
- The project template is based on [ant-admin-template](https://github.com/leonwgc/ant-admin-template), which includes:
59
-
60
- - React + TypeScript
61
- - Ant Design component library
62
- - gdn-pack build tool
63
- - Routing & layout setup
64
-
65
54
  ## License
66
55
 
67
56
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neat-admin-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "CLI tool to initialize ant-admin project from template",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
package/README.zh-CN.md DELETED
@@ -1,67 +0,0 @@
1
- # ndc
2
-
3
- 一个基于 Node.js 的 CLI 工具,用于从 [ant-admin-template](https://github.com/leonwgc/ant-admin-template) 模板快速初始化 Ant Design 后台管理项目。
4
-
5
- [English](./README.md)
6
-
7
- ## 安装
8
-
9
- ```bash
10
- npm install -g ndc
11
- ```
12
-
13
- 或通过 `npx` 直接使用(无需全局安装):
14
-
15
- ```bash
16
- npx ndc init --dir my-admin-project
17
- ```
18
-
19
- ## 使用方法
20
-
21
- ```bash
22
- ndc init --dir <目录>
23
- ```
24
-
25
- ### 参数说明
26
-
27
- | 参数 | 说明 |
28
- |------|------|
29
- | `--dir <目录>` | 新项目的目标目录名称或路径(必填) |
30
- | `-V, --version` | 输出版本号 |
31
- | `-h, --help` | 显示帮助信息 |
32
-
33
- ### 示例
34
-
35
- ```bash
36
- # 在当前目录下创建项目
37
- ndc init --dir my-admin-project
38
-
39
- # 指定绝对路径创建项目
40
- ndc init --dir /path/to/my-admin-project
41
- ```
42
-
43
- 初始化完成后,工具会依次执行:
44
-
45
- 1. 使用 `git clone --depth 1` 克隆模板仓库
46
- 2. 删除原始 `.git`,重新初始化为全新 git 仓库
47
- 3. 使用 `npm install` 自动安装依赖
48
-
49
- 然后启动开发服务器:
50
-
51
- ```bash
52
- cd my-admin-project
53
- npm run dev
54
- ```
55
-
56
- ## 模板介绍
57
-
58
- 项目模板基于 [ant-admin-template](https://github.com/leonwgc/ant-admin-template),包含以下技术栈:
59
-
60
- - React + TypeScript
61
- - Ant Design 组件库
62
- - gdn-pack 构建工具
63
- - 路由与布局结构
64
-
65
- ## License
66
-
67
- MIT