samanbayaka 0.0.18 → 0.0.20
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 +14 -10
- package/commit-hash.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,15 @@ This project is a modular, production-ready microservices framework built with M
|
|
|
9
9
|
[](https://www.npmjs.com/package/samanbayaka)
|
|
10
10
|
[](LICENSE)
|
|
11
11
|
|
|
12
|
-
#
|
|
12
|
+
- [Table of contents](#table-of-contents)
|
|
13
|
+
- [Features](#features)
|
|
14
|
+
- [Installation](#installation)
|
|
15
|
+
- [Prerequisites](#prerequisites)
|
|
16
|
+
- [Documentations](#documentations)
|
|
17
|
+
- [Usage](#usage)
|
|
18
|
+
- [Demo](#Demo)
|
|
19
|
+
|
|
20
|
+
## Features
|
|
13
21
|
|
|
14
22
|
- Moleculer-based microservices architecture
|
|
15
23
|
- NATS transporter for high-performance messaging
|
|
@@ -23,12 +31,8 @@ This project is a modular, production-ready microservices framework built with M
|
|
|
23
31
|
- Config-driven initialization
|
|
24
32
|
- Metrics and Log shipping for Grafana
|
|
25
33
|
|
|
26
|
-
# Documentation
|
|
27
|
-
|
|
28
|
-
* Dockers
|
|
29
|
-
* [Etcd](docs/dockers/etcd.md)
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
## Installation
|
|
32
36
|
|
|
33
37
|
```bash
|
|
34
38
|
pnpm install samanbayaka
|
|
@@ -37,7 +41,7 @@ Once the package is installed, you can import the library using import or requir
|
|
|
37
41
|
```bash
|
|
38
42
|
import sbk from "samanbayaka"
|
|
39
43
|
```
|
|
40
|
-
|
|
44
|
+
## Prerequisites
|
|
41
45
|
It is assumed that NATS, Redpanda, Redis, and Etcd are installed and properly configured. All services should be discoverable through the /etc/hosts file.
|
|
42
46
|
#### Minimum required Node.js version: >= 22.x.x
|
|
43
47
|
```bash
|
|
@@ -117,7 +121,7 @@ Paste this:
|
|
|
117
121
|
}
|
|
118
122
|
```
|
|
119
123
|
|
|
120
|
-
##
|
|
124
|
+
## Documentations
|
|
121
125
|
|
|
122
126
|
### sbk.Errors
|
|
123
127
|
|
|
@@ -248,7 +252,7 @@ Example:
|
|
|
248
252
|
}
|
|
249
253
|
```
|
|
250
254
|
|
|
251
|
-
|
|
255
|
+
## Usage
|
|
252
256
|
#### Create gateway service
|
|
253
257
|
The Gateway is a critical service that exposes all endpoints as REST APIs. At least one Gateway service must be running to make the REST APIs accessible.
|
|
254
258
|
```bash
|
|
@@ -420,7 +424,7 @@ cd <your_path>/hello
|
|
|
420
424
|
node index.mjs >> /var/log/samanbayaka/sbk-${HOSTNAME}-$$.log 2>&1
|
|
421
425
|
```
|
|
422
426
|
|
|
423
|
-
|
|
427
|
+
## Demo
|
|
424
428
|
You can also run the demo service to better understand how microservices work in the Moleculer ecosystem and how REST APIs are exposed.
|
|
425
429
|
```bash
|
|
426
430
|
mkdir demo
|
package/commit-hash.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const COMMIT_HASH = '
|
|
1
|
+
export const COMMIT_HASH = '8d687db';
|