codeweaver 3.0.0 → 3.0.2
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 +22 -8
- package/command.js +0 -8
- package/package.json +5 -2
- package/tsconfig.json +1 -1
package/README.md
CHANGED
|
@@ -26,24 +26,38 @@ To get started with the project, follow these steps:
|
|
|
26
26
|
1. **Clone the repository**:
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
|
-
npm
|
|
30
|
-
npx
|
|
29
|
+
npm i -g codeweaver
|
|
30
|
+
npx codeweaver my-app
|
|
31
31
|
cd my-app
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
2. **
|
|
34
|
+
2. **Clone the repository**:
|
|
35
|
+
|
|
36
|
+
Using pnpm:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pnpm i
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Using npm:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm i
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
3. **Run the application**:
|
|
35
49
|
|
|
36
50
|
```bash
|
|
37
|
-
|
|
51
|
+
npm start
|
|
38
52
|
```
|
|
39
53
|
|
|
40
|
-
|
|
54
|
+
4. **Visit the Swagger UI**: Open your browser and go to `http://localhost:3000/api-docs` to view the automatically generated API documentation.
|
|
41
55
|
|
|
42
|
-
|
|
56
|
+
5. **Build**: Compile the TypeScript files for the production environment:
|
|
43
57
|
|
|
44
58
|
```bash
|
|
45
|
-
|
|
46
|
-
|
|
59
|
+
npm run build
|
|
60
|
+
npm run serve
|
|
47
61
|
```
|
|
48
62
|
|
|
49
63
|
## Sample Project Structure
|
package/command.js
CHANGED
|
@@ -68,14 +68,6 @@ const access = promisify(fs.access);
|
|
|
68
68
|
console.error(`Error removing .git folder: ${err.message}`);
|
|
69
69
|
// continue anyway
|
|
70
70
|
}
|
|
71
|
-
|
|
72
|
-
// Run npm install inside the project directory
|
|
73
|
-
await exec(`cd ${projectName} && pnpm install`);
|
|
74
|
-
console.log(
|
|
75
|
-
`Successfully prepared ${path.resolve(
|
|
76
|
-
projectName
|
|
77
|
-
)} and installed dependencies.`
|
|
78
|
-
);
|
|
79
71
|
} catch (error) {
|
|
80
72
|
console.error(`Error: ${error.message}`);
|
|
81
73
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codeweaver",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.2",
|
|
4
4
|
"main": "src/main.ts",
|
|
5
|
+
"bin": {
|
|
6
|
+
"codeweaver": "./command.js"
|
|
7
|
+
},
|
|
5
8
|
"scripts": {
|
|
6
9
|
"start": "nodemon -r tsconfig-paths/register src/main.ts",
|
|
7
10
|
"dev": "nodemon -r tsconfig-paths/register src/main.ts",
|
|
@@ -11,7 +14,7 @@
|
|
|
11
14
|
"keywords": [
|
|
12
15
|
"framework",
|
|
13
16
|
"lightweight",
|
|
14
|
-
"
|
|
17
|
+
"node",
|
|
15
18
|
"Express",
|
|
16
19
|
"boilerplate",
|
|
17
20
|
"utility",
|