RulerChen · RulerChen · Jan 15, 2025 · Feb 2, 2025
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -3,8 +3,8 @@ name: Publish package to NPM
 on:
   push:
     tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
-      - '*-beta.*' # ex : v1.0.0-beta.1
+      - '[0-9]+.[0-9]+.[0-9]+' # ex : 1.0.0
+      - '*-beta.*' # ex : 1.0.0-beta.1
 
 permissions:
   contents: write

diff --git a/.npmignore b/.npmignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [3.1.1] - 2025-02-02
 
-- Nothing yet.
+- [Updated] Update README.md file for better documentation.
+- [Updated] Update package.json file.
+- [Updated] Remove .npmignore file.
 
 ## [3.1.0] - 2025-01-15
 

diff --git a/README.md b/README.md
@@ -32,9 +32,13 @@
 
 ```bash
 npx gen-express-cli@latest <project-name>
+```
 
+```bash
 cd <project-name>
+```
 
+```bash
 npm run dev # for development
 npm run start # for production
 npm run build # for typescript build
@@ -48,7 +52,7 @@ docker build -t <image-name> .
 
 ## 📖 Usage
 
-<!-- ![Usage](/docs/usage.png) -->
+![Usage](/docs/usage.png)
 
 ```bash
 npx gen-express-cli --help

diff --git a/docs/usage.png b/docs/usage.png
diff --git a/package.json b/package.json
@@ -1,34 +1,27 @@
 {
   "name": "gen-express-cli",
-  "version": "v3.1.0",
-  "description": "A simple express cli to generate express app simply by running a command",
+  "version": "3.1.1",
+  "description": "A simple express cli to generate express app simply by running a command, similar to express-generator",
   "main": "index.js",
+  "author": "RulerChen",
+  "license": "MIT",
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/RulerChen/gen-express-cli.git"
   },
+  "homepage": "https://github.com/RulerChen/gen-express-cli#readme",
   "bugs": {
-    "url": "https://github.com/RulerChen/gen-express-cli"
+    "url": "https://github.com/RulerChen/gen-express-cli/issues"
   },
   "engines": {
     "node": ">=20.0.0"
   },
   "scripts": {
-    "start": "node index.js"
+    "start": "node ./src/index.js"
   },
-  "keywords": [
-    "gen-express-cli",
-    "node",
-    "express",
-    "cli",
-    "backend",
-    "express-generator"
-  ],
-  "author": "RulerChen",
-  "license": "MIT",
   "bin": {
-    "gen-express-cli": "index.js"
+    "gen-express-cli": "src/index.js"
   },
   "dependencies": {
     "chalk": "^5.3.0",
@@ -37,5 +30,24 @@
     "gradient-string": "^2.0.2",
     "inquirer": "^9.2.13",
     "nanospinner": "^1.1.0"
-  }
+  },
+  "files": [
+    "src/",
+    "docs/",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "keywords": [
+    "node",
+    "node.js",
+    "express",
+    "express.js",
+    "express.js cli",
+    "express-generator",
+    "gen-express-cli",
+    "create-express-app",
+    "cli",
+    "backend"
+  ]
 }
diff --git a/index.js → src/index.js b/index.js → src/index.js
diff --git a/scripts/createBase.js → src/scripts/createBase.js b/scripts/createBase.js → src/scripts/createBase.js
diff --git a/scripts/createDoc.js → src/scripts/createDoc.js b/scripts/createDoc.js → src/scripts/createDoc.js
diff --git a/scripts/createDocker.js → src/scripts/createDocker.js b/scripts/createDocker.js → src/scripts/createDocker.js
diff --git a/scripts/createJsConfig.js → src/scripts/createJsConfig.js b/scripts/createJsConfig.js → src/scripts/createJsConfig.js
diff --git a/scripts/createLinter.js → src/scripts/createLinter.js b/scripts/createLinter.js → src/scripts/createLinter.js
diff --git a/scripts/createPackageJson.js → src/scripts/createPackageJson.js b/scripts/createPackageJson.js → src/scripts/createPackageJson.js
diff --git a/scripts/createProject.js → src/scripts/createProject.js b/scripts/createProject.js → src/scripts/createProject.js
diff --git a/scripts/createTsConfig.js → src/scripts/createTsConfig.js b/scripts/createTsConfig.js → src/scripts/createTsConfig.js
diff --git a/scripts/createUnitTest.js → src/scripts/createUnitTest.js b/scripts/createUnitTest.js → src/scripts/createUnitTest.js
diff --git a/scripts/index.js → src/scripts/index.js b/scripts/index.js → src/scripts/index.js
diff --git a/scripts/printAlias.js → src/scripts/printAlias.js b/scripts/printAlias.js → src/scripts/printAlias.js
diff --git a/scripts/printDocker.js → src/scripts/printDocker.js b/scripts/printDocker.js → src/scripts/printDocker.js
diff --git a/scripts/printDocs.js → src/scripts/printDocs.js b/scripts/printDocs.js → src/scripts/printDocs.js
diff --git a/scripts/printLinter.js → src/scripts/printLinter.js b/scripts/printLinter.js → src/scripts/printLinter.js
diff --git a/scripts/printProjectManager.js → src/scripts/printProjectManager.js b/scripts/printProjectManager.js → src/scripts/printProjectManager.js
diff --git a/scripts/printProjectName.js → src/scripts/printProjectName.js b/scripts/printProjectName.js → src/scripts/printProjectName.js
diff --git a/scripts/printTemplate.js → src/scripts/printTemplate.js b/scripts/printTemplate.js → src/scripts/printTemplate.js
diff --git a/scripts/printUnitTest.js → src/scripts/printUnitTest.js b/scripts/printUnitTest.js → src/scripts/printUnitTest.js
diff --git a/templates/.eslintrc.json → src/templates/.eslintrc.json b/templates/.eslintrc.json → src/templates/.eslintrc.json
diff --git a/templates/.prettierrc.json → src/templates/.prettierrc.json b/templates/.prettierrc.json → src/templates/.prettierrc.json
diff --git a/templates/base/common/.env → src/templates/base/common/.env b/templates/base/common/.env → src/templates/base/common/.env
diff --git a/templates/base/common/.env.development → src/templates/base/common/.env.development b/templates/base/common/.env.development → src/templates/base/common/.env.development
diff --git a/templates/base/common/README.md → src/templates/base/common/README.md b/templates/base/common/README.md → src/templates/base/common/README.md
diff --git a/templates/base/common/gitignore.txt → src/templates/base/common/gitignore.txt b/templates/base/common/gitignore.txt → src/templates/base/common/gitignore.txt
diff --git a/.../javascript-alias/src/controllers/user.js → .../javascript-alias/src/controllers/user.js b/.../javascript-alias/src/controllers/user.js → .../javascript-alias/src/controllers/user.js
diff --git a/templates/base/javascript-alias/src/index.js → ...plates/base/javascript-alias/src/index.js b/templates/base/javascript-alias/src/index.js → ...plates/base/javascript-alias/src/index.js
diff --git a/.../base/javascript-alias/src/models/user.js → .../base/javascript-alias/src/models/user.js b/.../base/javascript-alias/src/models/user.js → .../base/javascript-alias/src/models/user.js
diff --git a/...base/javascript-alias/src/routes/index.js → ...base/javascript-alias/src/routes/index.js b/...base/javascript-alias/src/routes/index.js → ...base/javascript-alias/src/routes/index.js
diff --git a/.../base/javascript-alias/src/routes/user.js → .../base/javascript-alias/src/routes/user.js b/.../base/javascript-alias/src/routes/user.js → .../base/javascript-alias/src/routes/user.js
diff --git a/...s/base/javascript/src/controllers/user.js → ...s/base/javascript/src/controllers/user.js b/...s/base/javascript/src/controllers/user.js → ...s/base/javascript/src/controllers/user.js
diff --git a/templates/base/javascript/src/index.js → src/templates/base/javascript/src/index.js b/templates/base/javascript/src/index.js → src/templates/base/javascript/src/index.js
diff --git a/templates/base/javascript/src/models/user.js → ...plates/base/javascript/src/models/user.js b/templates/base/javascript/src/models/user.js → ...plates/base/javascript/src/models/user.js
diff --git a/...lates/base/javascript/src/routes/index.js → ...lates/base/javascript/src/routes/index.js b/...lates/base/javascript/src/routes/index.js → ...lates/base/javascript/src/routes/index.js
diff --git a/templates/base/javascript/src/routes/user.js → ...plates/base/javascript/src/routes/user.js b/templates/base/javascript/src/routes/user.js → ...plates/base/javascript/src/routes/user.js
diff --git a/...es/base/typescript-alias/process.env.d.ts → ...es/base/typescript-alias/process.env.d.ts b/...es/base/typescript-alias/process.env.d.ts → ...es/base/typescript-alias/process.env.d.ts
diff --git a/.../typescript-alias/src/controllers/user.ts → .../typescript-alias/src/controllers/user.ts b/.../typescript-alias/src/controllers/user.ts → .../typescript-alias/src/controllers/user.ts
diff --git a/templates/base/typescript-alias/src/index.ts → ...plates/base/typescript-alias/src/index.ts b/templates/base/typescript-alias/src/index.ts → ...plates/base/typescript-alias/src/index.ts
diff --git a/.../base/typescript-alias/src/models/user.ts → .../base/typescript-alias/src/models/user.ts b/.../base/typescript-alias/src/models/user.ts → .../base/typescript-alias/src/models/user.ts
diff --git a/...base/typescript-alias/src/routes/index.ts → ...base/typescript-alias/src/routes/index.ts b/...base/typescript-alias/src/routes/index.ts → ...base/typescript-alias/src/routes/index.ts
diff --git a/.../base/typescript-alias/src/routes/user.ts → .../base/typescript-alias/src/routes/user.ts b/.../base/typescript-alias/src/routes/user.ts → .../base/typescript-alias/src/routes/user.ts
diff --git a/templates/base/typescript/process.env.d.ts → ...emplates/base/typescript/process.env.d.ts b/templates/base/typescript/process.env.d.ts → ...emplates/base/typescript/process.env.d.ts
diff --git a/...s/base/typescript/src/controllers/user.ts → ...s/base/typescript/src/controllers/user.ts b/...s/base/typescript/src/controllers/user.ts → ...s/base/typescript/src/controllers/user.ts
diff --git a/templates/base/typescript/src/index.ts → src/templates/base/typescript/src/index.ts b/templates/base/typescript/src/index.ts → src/templates/base/typescript/src/index.ts
diff --git a/templates/base/typescript/src/models/user.ts → ...plates/base/typescript/src/models/user.ts b/templates/base/typescript/src/models/user.ts → ...plates/base/typescript/src/models/user.ts
diff --git a/...lates/base/typescript/src/routes/index.ts → ...lates/base/typescript/src/routes/index.ts b/...lates/base/typescript/src/routes/index.ts → ...lates/base/typescript/src/routes/index.ts
diff --git a/templates/base/typescript/src/routes/user.ts → ...plates/base/typescript/src/routes/user.ts b/templates/base/typescript/src/routes/user.ts → ...plates/base/typescript/src/routes/user.ts
diff --git a/templates/docker/javascript/.dockerignore → ...templates/docker/javascript/.dockerignore b/templates/docker/javascript/.dockerignore → ...templates/docker/javascript/.dockerignore
diff --git a/templates/docker/javascript/Dockerfile → src/templates/docker/javascript/Dockerfile b/templates/docker/javascript/Dockerfile → src/templates/docker/javascript/Dockerfile
diff --git a/templates/docker/typescript/.dockerignore → ...templates/docker/typescript/.dockerignore b/templates/docker/typescript/.dockerignore → ...templates/docker/typescript/.dockerignore
diff --git a/templates/docker/typescript/Dockerfile → src/templates/docker/typescript/Dockerfile b/templates/docker/typescript/Dockerfile → src/templates/docker/typescript/Dockerfile
diff --git a/templates/jsconfig.json → src/templates/jsconfig.json b/templates/jsconfig.json → src/templates/jsconfig.json
diff --git a/templates/package.json → src/templates/package.json b/templates/package.json → src/templates/package.json
diff --git a/...ates/swagger/javascript-alias/apidoc.json → ...ates/swagger/javascript-alias/apidoc.json b/...ates/swagger/javascript-alias/apidoc.json → ...ates/swagger/javascript-alias/apidoc.json
diff --git a/...tes/swagger/javascript-alias/src/index.js → ...tes/swagger/javascript-alias/src/index.js b/...tes/swagger/javascript-alias/src/index.js → ...tes/swagger/javascript-alias/src/index.js
diff --git a/...lates/swagger/javascript-alias/swagger.js → ...lates/swagger/javascript-alias/swagger.js b/...lates/swagger/javascript-alias/swagger.js → ...lates/swagger/javascript-alias/swagger.js
diff --git a/templates/swagger/javascript/apidoc.json → src/templates/swagger/javascript/apidoc.json b/templates/swagger/javascript/apidoc.json → src/templates/swagger/javascript/apidoc.json
diff --git a/templates/swagger/javascript/src/index.js → ...templates/swagger/javascript/src/index.js b/templates/swagger/javascript/src/index.js → ...templates/swagger/javascript/src/index.js
diff --git a/templates/swagger/javascript/swagger.js → src/templates/swagger/javascript/swagger.js b/templates/swagger/javascript/swagger.js → src/templates/swagger/javascript/swagger.js
diff --git a/...ates/swagger/typescript-alias/apidoc.json → ...ates/swagger/typescript-alias/apidoc.json b/...ates/swagger/typescript-alias/apidoc.json → ...ates/swagger/typescript-alias/apidoc.json
diff --git a/...tes/swagger/typescript-alias/src/index.ts → ...tes/swagger/typescript-alias/src/index.ts b/...tes/swagger/typescript-alias/src/index.ts → ...tes/swagger/typescript-alias/src/index.ts
diff --git a/...lates/swagger/typescript-alias/swagger.ts → ...lates/swagger/typescript-alias/swagger.ts b/...lates/swagger/typescript-alias/swagger.ts → ...lates/swagger/typescript-alias/swagger.ts
diff --git a/templates/swagger/typescript/apidoc.json → src/templates/swagger/typescript/apidoc.json b/templates/swagger/typescript/apidoc.json → src/templates/swagger/typescript/apidoc.json
diff --git a/templates/swagger/typescript/src/index.ts → ...templates/swagger/typescript/src/index.ts b/templates/swagger/typescript/src/index.ts → ...templates/swagger/typescript/src/index.ts
diff --git a/templates/swagger/typescript/swagger.ts → src/templates/swagger/typescript/swagger.ts b/templates/swagger/typescript/swagger.ts → src/templates/swagger/typescript/swagger.ts
diff --git a/templates/tsconfig.json → src/templates/tsconfig.json b/templates/tsconfig.json → src/templates/tsconfig.json
diff --git a/...ates/unit/javascript-alias/jest.config.js → ...ates/unit/javascript-alias/jest.config.js b/...ates/unit/javascript-alias/jest.config.js → ...ates/unit/javascript-alias/jest.config.js
diff --git a/...vascript-alias/src/__tests__/user.spec.js → ...vascript-alias/src/__tests__/user.spec.js b/...vascript-alias/src/__tests__/user.spec.js → ...vascript-alias/src/__tests__/user.spec.js
diff --git a/templates/unit/javascript/jest.config.js → src/templates/unit/javascript/jest.config.js b/templates/unit/javascript/jest.config.js → src/templates/unit/javascript/jest.config.js
diff --git a/...nit/javascript/src/__tests__/user.spec.js → ...nit/javascript/src/__tests__/user.spec.js b/...nit/javascript/src/__tests__/user.spec.js → ...nit/javascript/src/__tests__/user.spec.js
diff --git a/...ates/unit/typescript-alias/jest.config.ts → ...ates/unit/typescript-alias/jest.config.ts b/...ates/unit/typescript-alias/jest.config.ts → ...ates/unit/typescript-alias/jest.config.ts
diff --git a/...pescript-alias/src/__tests__/user.spec.ts → ...pescript-alias/src/__tests__/user.spec.ts b/...pescript-alias/src/__tests__/user.spec.ts → ...pescript-alias/src/__tests__/user.spec.ts
diff --git a/templates/unit/typescript/jest.config.ts → src/templates/unit/typescript/jest.config.ts b/templates/unit/typescript/jest.config.ts → src/templates/unit/typescript/jest.config.ts
diff --git a/...nit/typescript/src/__tests__/user.spec.ts → ...nit/typescript/src/__tests__/user.spec.ts b/...nit/typescript/src/__tests__/user.spec.ts → ...nit/typescript/src/__tests__/user.spec.ts
diff --git a/utils/exec.js → src/utils/exec.js b/utils/exec.js → src/utils/exec.js
diff --git a/utils/isProjectExist.js → src/utils/isProjectExist.js b/utils/isProjectExist.js → src/utils/isProjectExist.js
diff --git a/variables/data.js → src/variables/data.js b/variables/data.js → src/variables/data.js
diff --git a/variables/templates.js → src/variables/templates.js b/variables/templates.js → src/variables/templates.js