@incloodsolutions/devkit 0.0.1 → 0.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 +42 -16
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,32 +1,58 @@
|
|
|
1
|
-
# @incloodsolutions/
|
|
1
|
+
# @incloodsolutions/devkit
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
4
|
+
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
5
|
+
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
6
|
+
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
7
7
|
|
|
8
|
-
A Node.js
|
|
9
|
-
Includes async helpers, file system utilities, configuration management, and runtime tools optimised for building scalable Node.js backends and CLI tools.
|
|
8
|
+
A comprehensive development toolkit for Node.js and TypeScript applications. It provides reusable development utilities, configuration helpers, AWS CDK constructs and stacks, build tooling, project scaffolding, and other resources to simplify modern application development and infrastructure management.
|
|
10
9
|
|
|
11
10
|
---
|
|
12
11
|
|
|
13
12
|
## 📦 Installation
|
|
14
13
|
|
|
15
14
|
```bash
|
|
16
|
-
npm install @incloodsolutions/
|
|
15
|
+
npm install @incloodsolutions/devkit
|
|
17
16
|
# or
|
|
18
|
-
yarn add @incloodsolutions/
|
|
17
|
+
yarn add @incloodsolutions/devkit
|
|
19
18
|
```
|
|
20
19
|
|
|
21
20
|
## 🚀 Usage
|
|
22
21
|
|
|
23
22
|
```typescript
|
|
24
|
-
import {
|
|
23
|
+
import { EnvironmentHelper } from "@incloodsolutions/devkit";
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
console.log(config);
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
main();
|
|
25
|
+
// Example usage
|
|
26
|
+
const env = EnvironmentHelper.load();
|
|
32
27
|
```
|
|
28
|
+
|
|
29
|
+
## ✨ Features
|
|
30
|
+
|
|
31
|
+
- ⚙️ Node.js development utilities
|
|
32
|
+
- 📝 Configuration management
|
|
33
|
+
- 🏗️ AWS CDK constructs
|
|
34
|
+
- ☁️ Reusable AWS CDK stacks
|
|
35
|
+
- 🛠️ Infrastructure helpers
|
|
36
|
+
- 🔐 IAM, Route53, ACM, Lambda, API Gateway, S3 & DynamoDB utilities
|
|
37
|
+
- 🏷️ Resource naming & tagging helpers
|
|
38
|
+
- 📁 Project templates & scaffolding
|
|
39
|
+
- 🧩 Build & release utilities
|
|
40
|
+
- 🔧 Development tooling and helpers
|
|
41
|
+
- 💙 First-class TypeScript support
|
|
42
|
+
|
|
43
|
+
## 🎯 Goals
|
|
44
|
+
|
|
45
|
+
- Reduce development and infrastructure boilerplate
|
|
46
|
+
- Standardise project structure and configuration
|
|
47
|
+
- Promote reusable infrastructure components
|
|
48
|
+
- Simplify AWS CDK development
|
|
49
|
+
- Improve developer productivity
|
|
50
|
+
- Encourage consistency across projects
|
|
51
|
+
- Provide sensible defaults while remaining extensible
|
|
52
|
+
|
|
53
|
+
## 📚 Part of the IncloodSolutions Toolkit Ecosystem
|
|
54
|
+
|
|
55
|
+
- **@incloodsolutions/toolkit** — Core utilities and shared helpers
|
|
56
|
+
- **@incloodsolutions/node-toolkit** — Node.js runtime and backend utilities
|
|
57
|
+
- **@incloodsolutions/toolkit-react** — React utilities and components
|
|
58
|
+
- **@incloodsolutions/devkit** — Development tooling, configuration, AWS CDK constructs, stacks, and infrastructure utilities
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@incloodsolutions/devkit",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "A toolkit
|
|
3
|
+
"version": "0.0.2",
|
|
4
|
+
"description": "A comprehensive development toolkit for Node.js and TypeScript, providing development utilities, configuration helpers, AWS CDK constructs, stacks, and infrastructure tooling.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
7
7
|
"module": "./dist/index.js",
|