From b45180063a5aa400402ab77c9454d777055a32f6 Mon Sep 17 00:00:00 2001 From: RyanHUNGry Date: Sat, 2 Sep 2023 00:51:51 -0700 Subject: [PATCH] readme --- README.md | 3 +++ package-lock.json | 17 +++++++++++++++++ package.json | 3 +++ 3 files changed, 23 insertions(+) diff --git a/README.md b/README.md index 6cfc4a7..84ce036 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,9 @@ npm run watch ### Testing Suite *dataflow* comes with full unit and integration test suites for its API. +### Containerization +*dataflow* depends on itself or external cloud services via AWS. There isn't an additional service that needs to be installed on a host. This means that containerizing a working version of *dataflow* only consists of bundling the application itself with the correct environment variables. Since the application itself is stateless due to cloud, there is no need for volumes either. + ## API diff --git a/package-lock.json b/package-lock.json index d2a613a..0de5c23 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,6 +8,9 @@ "name": "dataflow-project", "version": "1.0.0", "license": "ISC", + "dependencies": { + "start": "^5.1.0" + }, "devDependencies": { "concurrently": "^8.2.0" } @@ -238,6 +241,15 @@ "integrity": "sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ==", "dev": true }, + "node_modules/start": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/start/-/start-5.1.0.tgz", + "integrity": "sha512-lirwWQmvBC65bnxU3HzKx5m7vfZJZTx/FrKyPWbtobcvujGbinQQRrNodtcgkp4mTZ00umzDeg7lraN351l0aA==", + "deprecated": "Deprecated in favor of https://github.com/deepsweet/start", + "engines": { + "node": ">=4" + } + }, "node_modules/string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -515,6 +527,11 @@ "integrity": "sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ==", "dev": true }, + "start": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/start/-/start-5.1.0.tgz", + "integrity": "sha512-lirwWQmvBC65bnxU3HzKx5m7vfZJZTx/FrKyPWbtobcvujGbinQQRrNodtcgkp4mTZ00umzDeg7lraN351l0aA==" + }, "string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", diff --git a/package.json b/package.json index ad815ec..2109bb5 100644 --- a/package.json +++ b/package.json @@ -17,5 +17,8 @@ "homepage": "https://github.com/RyanHUNGry/dataflow#readme", "devDependencies": { "concurrently": "^8.2.0" + }, + "dependencies": { + "start": "^5.1.0" } }