go-duck-cli 1.0.0 → 1.0.1
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 +62 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,24 +1,47 @@
|
|
|
1
1
|
# GO-DUCK CLI
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="../MARKETING/logo.png" alt="Go-Duck Logo" width="200"/>
|
|
5
|
+
</p>
|
|
5
6
|
|
|
6
|
-
|
|
7
|
+
<h1 align="center">GO-DUCK: The Evolutionary Architecture Factory</h1>
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
<p align="center">
|
|
10
|
+
Where high-velocity Gophers meet the versatile wisdom of the Duck to scaffold microservices that thrive in chaos.
|
|
11
|
+
</p>
|
|
9
12
|
|
|
10
|
-
|
|
13
|
+
<p align="center">
|
|
14
|
+
<a href="https://badge.fury.io/js/go-duck-cli"><img src="https://badge.fury.io/js/go-duck-cli.svg" alt="npm version"></a>
|
|
15
|
+
<a href="https://opensource.org/licenses/ISC"><img src="https://img.shields.io/badge/License-ISC-blue.svg" alt="License: ISC"></a>
|
|
16
|
+
</p>
|
|
11
17
|
|
|
12
|
-
|
|
18
|
+
---
|
|
13
19
|
|
|
14
|
-
|
|
15
|
-
* **Kratos** for gRPC
|
|
16
|
-
* **GORM** for database interaction (PostgreSQL)
|
|
17
|
-
* **Liquibase** for database migrations
|
|
18
|
-
* **OpenTelemetry** for observability
|
|
19
|
-
* And many more...
|
|
20
|
+
## 🦆 The Legend of the Century
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
In the legendary Silicon Valley of Code, a nomadic Gopher—lightning-fast and known for his tireless concurrency—crossed paths with a Duck from the Great Persistence Bayou. The Duck held the wisdom of adaptability and the secret to navigating ever-shifting business tides. They realized that while the Gopher built fast, the Duck built to survive. Together, they forged a pact to create the **Generator of Kings**.
|
|
23
|
+
|
|
24
|
+
### Gin Gonic Tonic: The Refreshment of Performance
|
|
25
|
+
|
|
26
|
+
To fuel their grand design, they sought the Legendary Bottle of Gin. This magical brew wasn't just for hydration; it transformed their web routing into a crystalline, high-performance flow. Routes became fast, middleware became transparent, and the developer experience became as refreshing as a cold tonic on a summer's day. This gave **GO-DUCK** its distinctive, lightweight spirit.
|
|
27
|
+
|
|
28
|
+
<p align="center">
|
|
29
|
+
<img src="../MARKETING/1.png" alt="Go-Duck Feature 1" width="400"/>
|
|
30
|
+
</p>
|
|
31
|
+
|
|
32
|
+
### The Armor of the Divine: Mark of Kratos
|
|
33
|
+
|
|
34
|
+
But speed without strength is a house made of cards. In the digital forge of the underworld, they recovered the Mark of Kratos. By stamping this sigil onto their internal services, they achieved gRPC industrial resilience. Every service became armored with strict Protocol Buffer contracts, ensuring that no matter how hard the system scaled, it would never break under the divine weight of technical debt.
|
|
35
|
+
|
|
36
|
+
<p align="center">
|
|
37
|
+
<img src="../MARKETING/2.png" alt="Go-Duck Feature 2" width="400"/>
|
|
38
|
+
</p>
|
|
39
|
+
|
|
40
|
+
### The GDL Genesis
|
|
41
|
+
|
|
42
|
+
Thus, the **GDL (Go-Duck Language)** was hatched. A single, simple tongue that could command entire legions of code. From that day forth, every developer who whispered GDL into the CLI would see their architecture evolve—bringing the Gopher's speed, the Duck's wisdom, the Gin's clarity, and the Kratos' strength into a single, unified masterpiece.
|
|
43
|
+
|
|
44
|
+
## ✨ Features Overview
|
|
22
45
|
|
|
23
46
|
* **Full-Stack Code Generation**: Generates everything from REST and gRPC APIs to the data access layer.
|
|
24
47
|
* **Dual-Protocol APIs**: Out-of-the-box support for both REST (Gin) and gRPC (Kratos).
|
|
@@ -35,12 +58,37 @@ The generated application is built on a modern stack, including:
|
|
|
35
58
|
* **Automated Documentation**: Generates a beautiful, multi-page HTML documentation portal for your project.
|
|
36
59
|
* **Cloud-Native**: Comes with Docker support and CI/CD pipelines using GitHub Actions.
|
|
37
60
|
|
|
38
|
-
## Installation
|
|
61
|
+
## 💾 Global Installation
|
|
62
|
+
|
|
63
|
+
To get started with GO-DUCK CLI, install it globally via npm:
|
|
39
64
|
|
|
40
65
|
```bash
|
|
41
66
|
npm install -g go-duck-cli
|
|
42
67
|
```
|
|
43
68
|
|
|
69
|
+
### Environment Specifications
|
|
70
|
+
|
|
71
|
+
Ensure your development environment meets the following requirements:
|
|
72
|
+
|
|
73
|
+
* **Node.js:** 18+
|
|
74
|
+
* **Go:** 1.21+
|
|
75
|
+
* **Docker:** v20+
|
|
76
|
+
* **Composability:** v2+
|
|
77
|
+
|
|
78
|
+
## 🚀 Scaffold & Run
|
|
79
|
+
|
|
80
|
+
Follow these steps to create and run a new microservice with GO-DUCK:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
# 1. Create a new microservice
|
|
84
|
+
go-duck create -o ./my-app -c config.yaml
|
|
85
|
+
|
|
86
|
+
# 2. Enter the application directory and run
|
|
87
|
+
cd my-app
|
|
88
|
+
docker-compose up -d
|
|
89
|
+
go run main.go
|
|
90
|
+
```
|
|
91
|
+
|
|
44
92
|
## Usage
|
|
45
93
|
|
|
46
94
|
The `go-duck-cli` has two main commands: `create` and `import-gdl`.
|