Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dario-vega/botnosql
(priv) Learn and Discover why NoSQL Cloud Services and OCI native services are compelling
https://github.com/dario-vega/botnosql
api-gateway bot digital-assistant nosql oraclenosql
Last synced: 1 day ago
JSON representation
(priv) Learn and Discover why NoSQL Cloud Services and OCI native services are compelling
- Host: GitHub
- URL: https://github.com/dario-vega/botnosql
- Owner: dario-vega
- Created: 2021-05-07T04:45:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-07T05:01:19.000Z (over 3 years ago)
- Last Synced: 2024-11-06T21:49:18.902Z (about 2 months ago)
- Topics: api-gateway, bot, digital-assistant, nosql, oraclenosql
- Language: JavaScript
- Homepage: https://www.oracle.com/database/nosql-cloud.html
- Size: 1010 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# botnosql
This project is in format of a Component Package. Component Packages are the
recommended way to organize Bots Custom Components code and allow the custom
component code to be more portable to different runtime environments.
> Generated by `@oracle/bots-node-sdk` on **Mon May 18 2020**
## Structure
```text
.
├── .npmignore
├── components
│ └── ...
├── main.js
├── package.json
└── spec
└── ...
```
| | Description |
|--|--|
| `.npmignore` | Ignore files when packaging as `npm` module |
| `components` | Directory _(default)_ where Component implementations are added |
| `main.js` | Entrypoint for the Custom Component Package configuration |
| `spec` | Placeholder for unit test implementations |
The Component Package behaves like any other `npm` project. Directly install
any dependencies or tools required to implement the customizations.
## Development
With `@oracle/bots-node-sdk` as a `devDependency` in a Component Package
gives the project some valuable command line functionality.
> **TIP:** Use `npm run bots-node-sdk` for additional CLI help and usage information.
This component package is ready to run as a local development service. Once the
service starts you may use a local tunnel, such as [`ngrok`](https://ngrok.com/),
and configure an _External_ Service to connect the components to your Skill.
```shell
npm start
# or run with additional options
npm run bots-node-sdk -- service .
# or run with debugger
node --inspect $(npm bin)/bots-node-sdk service .
```
With custom component services running, test endpoints like so: ⚠️DO not use those test - not IMPLEMENTED
```shell
# get component metadata
curl -X GET localhost:3000/components
# invoke custom component
curl -H "Content-Type: application/json" -d @./spec/test.cc.req.json localhost:3000/components/getByConfirmationCode
# invoke resolve entity event handler component
curl -H "Content-Type: application/json" -d @./spec/test.eh.req.json localhost:3000/components/resolveentities/getByConfirmationCode
```
## Deployment
As this package is designed to be installed and run with a corresponding service
wrapper, run `npm pack` and upload the resulting `.tgz` as a package for
the _Embedded Container_ service.
```shell
npm pack
# or validate and package with the @oracle/bots-node-sdk command line
npm run bots-node-sdk -- pack .
```
> **TIP:** use `npm run bots-node-sdk -- pack --help` for additional packaging
options.