@ti-engine/core 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 +31 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# ti-engine core
|
|
2
|
+
Flexible framework for the creation of microservices with [node.js](https://nodejs.org/).
|
|
3
|
+
|
|
4
|
+
## introduction
|
|
5
|
+
The **@ti-engine/core** is an open source, free to use - both for personal and commercial projects - framework for the creation of microservice-based solutions using **node.js**. The general architectural concept of the framework is based on a standard messenger system that allows certain customization but also provides predictability and traceability of its behavior.
|
|
6
|
+
|
|
7
|
+
Being a messenger system, the **@ti-engine/core** relies on a message broker for the actual exchange of messages between microservice instances. The default implementation of the framework uses [Redis](https://redis.io/) cache, however, you could create your own implementation using something like [Rabbit MQ](https://www.rabbitmq.com/). See the [advanced topics](#advanced-topics) section of this documentation for guides on how to do this.
|
|
8
|
+
|
|
9
|
+
Please be aware, that this framework is under active development and will expand in the near future. Make sure to keep an eye on the changes in case you want to use it in the meantime.
|
|
10
|
+
|
|
11
|
+
## prerequisites & installation
|
|
12
|
+
In order to run the basic ti-engine framework you will need a couple of things:
|
|
13
|
+
1. A local [node.js installation](https://nodejs.org/en/download/) with a minimum version of **14.17.0**
|
|
14
|
+
2. A local or remote [Redis cache installation](https://redis.io/download) with a minimum version of **5.0.14**
|
|
15
|
+
|
|
16
|
+
To get the framework itself, use the command `npm install @ti-engine/core`. And to include it directly in your package.json dependencies execute `npm install @ti-engine/core --save-prod`.
|
|
17
|
+
|
|
18
|
+
## getting started
|
|
19
|
+
Under development...
|
|
20
|
+
|
|
21
|
+
## architecture
|
|
22
|
+
Under development...
|
|
23
|
+
|
|
24
|
+
## creating a microservice
|
|
25
|
+
Under development...
|
|
26
|
+
|
|
27
|
+
## using the framework
|
|
28
|
+
Under development...
|
|
29
|
+
|
|
30
|
+
## advanced topics
|
|
31
|
+
Under development...
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ti-engine/core",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "The ti-engine is an open source, free to use - both for personal and commercial projects - framework for the creation of microservice-based solutions using node.js.",
|
|
5
5
|
"author": "Boris Kostadinov <kostadinov.boris@gmail.com>",
|
|
6
6
|
"license": "ISC",
|