@twin.org/node 0.0.3-next.10 → 0.0.3-next.11
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 +1 -3
- package/docs/changelog.md +14 -0
- package/docs/deployment-docker.md +4 -4
- package/docs/deployment-ec2.md +2 -2
- package/docs/examples.md +2 -2
- package/docs/open-api/spec.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
# TWIN Node
|
|
1
|
+
# TWIN Node
|
|
2
2
|
|
|
3
3
|
A REST server implementation support the routes from various packages.
|
|
4
4
|
|
|
5
|
-
A deployment of this API can be found here [https://node-api.twindev.org/info](https://node-api.twindev.org/info)
|
|
6
|
-
|
|
7
5
|
The OpenAPI Spec can be found here [TWIN Node OpenAPI Spec](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/twinfoundation/node/refs/heads/next/apps/node/docs/open-api/spec.json)
|
|
8
6
|
|
|
9
7
|
## Building and running the application
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/node - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.11](https://github.com/twinfoundation/node/compare/node-v0.0.3-next.10...node-v0.0.3-next.11) (2026-01-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* improve calculation of execution directory ([106d65d](https://github.com/twinfoundation/node/commit/106d65d7ad5524e2e147b681d68f9476c024cfaa))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/node-core bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.10](https://github.com/twinfoundation/node/compare/node-v0.0.3-next.9...node-v0.0.3-next.10) (2026-01-19)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -61,7 +61,7 @@ This example will map the local directory `/home/twin-node/data` and make it ava
|
|
|
61
61
|
The output from the docker container should be something like the following.
|
|
62
62
|
|
|
63
63
|
```shell
|
|
64
|
-
🌩️ TWIN Node
|
|
64
|
+
🌩️ TWIN Node v1.0.0
|
|
65
65
|
|
|
66
66
|
Execution Directory: /app
|
|
67
67
|
Locales Directory: /app/dist/locales
|
|
@@ -125,7 +125,7 @@ docker run -t -i -v /home/twin-node/data:/twin-node/data -p 3000:3000 twin-node
|
|
|
125
125
|
You should now see output similar to the following:
|
|
126
126
|
|
|
127
127
|
```shell
|
|
128
|
-
🌩️ TWIN Node
|
|
128
|
+
🌩️ TWIN Node v1.0.0
|
|
129
129
|
|
|
130
130
|
Execution Directory: /app
|
|
131
131
|
Locales Directory: /app/dist/locales
|
|
@@ -174,7 +174,7 @@ On successfully communicating with the server you should see something similar t
|
|
|
174
174
|
|
|
175
175
|
```json
|
|
176
176
|
{
|
|
177
|
-
"name": "TWIN Node
|
|
177
|
+
"name": "TWIN Node",
|
|
178
178
|
"version": "1.0.0"
|
|
179
179
|
}
|
|
180
180
|
```
|
|
@@ -183,7 +183,7 @@ The logging in the docker container should also show the request and response.
|
|
|
183
183
|
|
|
184
184
|
```shell
|
|
185
185
|
INFO [2024-07-24T08:46:25.283Z] ===> GET /info
|
|
186
|
-
INFO [2024-07-24T08:46:25.287Z] <=== 200 GET /info duration: 3987µs {"name":"TWIN Node
|
|
186
|
+
INFO [2024-07-24T08:46:25.287Z] <=== 200 GET /info duration: 3987µs {"name":"TWIN Node","version":"1.0.0"}
|
|
187
187
|
```
|
|
188
188
|
|
|
189
189
|
The API server responds to the correct terminate signals so that when the docker container is stopped the server will also stop gracefully.
|
package/docs/deployment-ec2.md
CHANGED
|
@@ -40,7 +40,7 @@ nginx -v
|
|
|
40
40
|
|
|
41
41
|
## Configuring nginx
|
|
42
42
|
|
|
43
|
-
We need to configure nginx to use the certificate and reverse proxy https traffic to the node
|
|
43
|
+
We need to configure nginx to use the certificate and reverse proxy https traffic to the node.
|
|
44
44
|
|
|
45
45
|
```shell
|
|
46
46
|
sudo nano /etc/nginx/nginx.conf
|
|
@@ -130,7 +130,7 @@ You might need to modify the location for the node version, you can find this ou
|
|
|
130
130
|
|
|
131
131
|
```shell
|
|
132
132
|
[Unit]
|
|
133
|
-
Description=TWIN Node
|
|
133
|
+
Description=TWIN Node
|
|
134
134
|
After=network.target
|
|
135
135
|
|
|
136
136
|
[Service]
|
package/docs/examples.md
CHANGED
|
@@ -7,13 +7,13 @@ To run the command from the package either:
|
|
|
7
7
|
Install `@twin.org/node` and use the following command:
|
|
8
8
|
|
|
9
9
|
```shell
|
|
10
|
-
twin-node
|
|
10
|
+
twin-node --help
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
or
|
|
14
14
|
|
|
15
15
|
```shell
|
|
16
|
-
npx "@twin.org/node"
|
|
16
|
+
npx "@twin.org/node" --help
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
### Display help listing all commands
|
package/docs/open-api/spec.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.11",
|
|
4
4
|
"description": "TWIN Node serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/node-core": "0.0.3-next.
|
|
17
|
+
"@twin.org/node-core": "0.0.3-next.11"
|
|
18
18
|
},
|
|
19
19
|
"bugs": {
|
|
20
20
|
"url": "git+https://github.com/twinfoundation/node/issues"
|