create-stb 1.1.0 β 1.2.0
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 +64 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,34 @@
|
|
|
1
|
-
#
|
|
1
|
+
# create-ntb
|
|
2
|
+
|
|
3
|
+
## Serverless TypeScript Boilerplate by Sam Newhouse
|
|
2
4
|
|
|
3
5
|
**A CLI to instantly scaffold a production-ready Serverless TypeScript Boilerplate.**
|
|
4
6
|
|
|
7
|
+
[](https://www.npmjs.com/package/create-stb)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
|
|
5
10
|
---
|
|
6
11
|
|
|
7
12
|
## π Features
|
|
8
13
|
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
- Automatically updates project name
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
+
- **Fast Setup** - Scaffold a complete serverless app in seconds
|
|
15
|
+
- **TypeScript Ready** - Full TypeScript support with AWS Lambda and DynamoDB
|
|
16
|
+
- **Zero Config** - Automatically updates project name and installs dependencies
|
|
17
|
+
- **Production Ready** - Includes all configs, sample handlers, and best practices
|
|
18
|
+
- **Local Development** - Docker Compose setup for local DynamoDB testing
|
|
19
|
+
- **Modern Stack** - Node.js 20.x, Serverless Framework, and AWS services
|
|
14
20
|
|
|
15
21
|
---
|
|
16
22
|
|
|
17
|
-
## π¦
|
|
23
|
+
## π¦ Quick Start
|
|
18
24
|
|
|
19
|
-
|
|
25
|
+
### Using npx (Recommended)
|
|
20
26
|
|
|
21
27
|
```bash
|
|
22
28
|
npx create-stb my-app
|
|
23
29
|
```
|
|
24
30
|
|
|
25
|
-
|
|
31
|
+
### Global Installation
|
|
26
32
|
|
|
27
33
|
```bash
|
|
28
34
|
npm install -g create-stb
|
|
@@ -37,39 +43,63 @@ create-stb my-app
|
|
|
37
43
|
npx create-stb <project-name>
|
|
38
44
|
```
|
|
39
45
|
|
|
40
|
-
This creates a directory
|
|
46
|
+
This creates a new directory with your project name in the current folder.
|
|
41
47
|
|
|
42
|
-
Example
|
|
48
|
+
### Example
|
|
43
49
|
|
|
44
50
|
```bash
|
|
45
|
-
npx create-stb
|
|
51
|
+
npx create-stb <project-name>
|
|
46
52
|
cd pineapple-api
|
|
47
53
|
npm run offline
|
|
48
54
|
```
|
|
49
55
|
|
|
56
|
+
Your serverless API will be running at `http://localhost:3000`
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## 𧩠What's Included
|
|
61
|
+
|
|
62
|
+
### Project Structure
|
|
63
|
+
|
|
64
|
+
- β
**Serverless Configuration** - Pre-configured `serverless.yml` for AWS Lambda
|
|
65
|
+
- β
**TypeScript Setup** - Ready-to-use TypeScript configuration
|
|
66
|
+
- β
**DynamoDB Integration** - Local DynamoDB with Docker Compose
|
|
67
|
+
- β
**Sample Handlers** - Example Lambda functions to get started
|
|
68
|
+
- β
**Development Scripts** - `offline`, `build`, `deploy` commands
|
|
69
|
+
- β
**Code Quality** - Prettier configuration for consistent formatting
|
|
70
|
+
- β
**Environment Config** - `.env.example` for environment variables
|
|
71
|
+
|
|
72
|
+
### Tech Stack
|
|
73
|
+
|
|
74
|
+
- **Runtime**: Node.js 20.x
|
|
75
|
+
- **Language**: TypeScript
|
|
76
|
+
- **Framework**: Serverless Framework
|
|
77
|
+
- **Cloud**: AWS (Lambda, DynamoDB, API Gateway)
|
|
78
|
+
- **Local Dev**: serverless-offline, Docker
|
|
79
|
+
|
|
50
80
|
---
|
|
51
81
|
|
|
52
|
-
##
|
|
82
|
+
## π Requirements
|
|
53
83
|
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
-
|
|
57
|
-
- Scripts: `offline`, `deploy`, `build`, etc.
|
|
58
|
-
- Clean codebase, ready for development
|
|
84
|
+
- Node.js >= 20.0.0
|
|
85
|
+
- npm >= 10.0.0
|
|
86
|
+
- Git (for cloning the template)
|
|
59
87
|
|
|
60
88
|
---
|
|
61
89
|
|
|
62
90
|
## π Links
|
|
63
91
|
|
|
64
|
-
- [GitHub
|
|
65
|
-
- [
|
|
66
|
-
- [
|
|
92
|
+
- **[GitHub Repository](https://github.com/SamNewhouse/create-stb)**
|
|
93
|
+
- **[NPM Package](https://www.npmjs.com/package/create-stb)**
|
|
94
|
+
- **[Report Issues](https://github.com/SamNewhouse/create-stb/issues)**
|
|
95
|
+
- **[Template Repository](https://github.com/SamNewhouse/create-stb/tree/main/serverless)**
|
|
67
96
|
|
|
68
97
|
---
|
|
69
98
|
|
|
70
99
|
## π€ Contributing
|
|
71
100
|
|
|
72
|
-
|
|
101
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
102
|
+
|
|
73
103
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
74
104
|
|
|
75
105
|
---
|
|
@@ -77,3 +107,15 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
|
77
107
|
## π License
|
|
78
108
|
|
|
79
109
|
MIT Β© [Sam Newhouse](https://github.com/SamNewhouse)
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## π Support
|
|
114
|
+
|
|
115
|
+
If you find this tool helpful, please consider:
|
|
116
|
+
|
|
117
|
+
- β Starring the [repository](https://github.com/SamNewhouse/create-stb)
|
|
118
|
+
- π [Reporting issues](https://github.com/SamNewhouse/create-stb/issues)
|
|
119
|
+
- π¬ Sharing feedback and suggestions
|
|
120
|
+
|
|
121
|
+
**Thank you for using create-stb!** π
|