create-stb 1.0.2 β 1.0.4
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 +79 -0
- package/package.json +1 -1
- package/serverless/package-lock.json +4 -4
- package/serverless/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# create-stb
|
|
2
|
+
|
|
3
|
+
**A CLI to instantly scaffold a production-ready Serverless TypeScript Boilerplate.**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## π Features
|
|
8
|
+
|
|
9
|
+
- Scaffolds a serverless app with TypeScript, AWS, and DynamoDB.
|
|
10
|
+
- Copies all template files, including configs and sample code.
|
|
11
|
+
- Automatically updates project name in `package.json` and `serverless.yml`.
|
|
12
|
+
- Installs dependencies for you.
|
|
13
|
+
- Simple and fastβno extra configuration.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## π¦ Installation
|
|
18
|
+
|
|
19
|
+
**Recommended: Use npx**
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx create-stb my-app
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or install globally:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g create-stb
|
|
29
|
+
create-stb my-app
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## π Usage
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npx create-stb <project-name>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
This creates a directory `<project-name>` in your current folder.
|
|
41
|
+
|
|
42
|
+
Example:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npx create-stb pineapple-api
|
|
46
|
+
cd pineapple-api
|
|
47
|
+
npm run offline
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 𧩠What You Get
|
|
53
|
+
|
|
54
|
+
- Preconfigured `serverless.yml` for AWS and Node.js 20.x
|
|
55
|
+
- TypeScript-ready project
|
|
56
|
+
- Local DynamoDB scripts and sample handlers
|
|
57
|
+
- Scripts: `offline`, `deploy`, `build`, etc.
|
|
58
|
+
- Clean codebase, ready for development
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## π Links
|
|
63
|
+
|
|
64
|
+
- [GitHub repository](https://github.com/SamNewhouse/create-stb)
|
|
65
|
+
- [Report issues](https://github.com/SamNewhouse/create-stb/issues)
|
|
66
|
+
- [NPM page](https://www.npmjs.com/package/create-stb)
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## π€ Contributing
|
|
71
|
+
|
|
72
|
+
Pull requests, suggestions, and issues are welcome!
|
|
73
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## π License
|
|
78
|
+
|
|
79
|
+
MIT Β© [Sam Newhouse](https://github.com/SamNewhouse)
|
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"dotenv": "17.2.3"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@types/aws-lambda": "8.10.
|
|
19
|
+
"@types/aws-lambda": "8.10.158",
|
|
20
20
|
"@types/dotenv": "6.1.1",
|
|
21
21
|
"@types/node": "24.7.2",
|
|
22
22
|
"prettier": "3.6.2",
|
|
@@ -2874,9 +2874,9 @@
|
|
|
2874
2874
|
}
|
|
2875
2875
|
},
|
|
2876
2876
|
"node_modules/@types/aws-lambda": {
|
|
2877
|
-
"version": "8.10.
|
|
2878
|
-
"resolved": "https://registry.npmjs.org/@types/aws-lambda/-/aws-lambda-8.10.
|
|
2879
|
-
"integrity": "sha512-
|
|
2877
|
+
"version": "8.10.158",
|
|
2878
|
+
"resolved": "https://registry.npmjs.org/@types/aws-lambda/-/aws-lambda-8.10.158.tgz",
|
|
2879
|
+
"integrity": "sha512-v/n2WsL1ksRKigfqZ9ff7ANobfT3t/T8kI8UOiur98tREwFulv9lRv+pDrocGPWOe3DpD2Y2GKRO+OiyxwgaCQ==",
|
|
2880
2880
|
"dev": true,
|
|
2881
2881
|
"license": "MIT"
|
|
2882
2882
|
},
|