https://github.com/ethernity-cloud/ethernity-cloud-sdk-js
https://github.com/ethernity-cloud/ethernity-cloud-sdk-js
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ethernity-cloud/ethernity-cloud-sdk-js
- Owner: ethernity-cloud
- License: agpl-3.0
- Created: 2024-08-16T13:05:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T13:29:28.000Z (over 1 year ago)
- Last Synced: 2024-10-27T15:11:49.415Z (over 1 year ago)
- Language: JavaScript
- Size: 242 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ethernity Cloud SDK JS
This project provides a set of tools and scripts to work with the Ethernity Cloud SDK in a JavaScript environment.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Scripts](#scripts)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Installation
To install the package and its dependencies, run:
```sh
npm install ethernity-cloud-sdk-js
```
## Usage
After installation, you can use the provided scripts to build, publish, and initialize your project.
## Pre-requisites
The sdk requires the following to be installed on your system:
- Node.js v20.04 or higher
- npm
- docker (daemon running in the background for build and publish scripts)
## Operating System compatibility
The sdk has been tested on the following operating systems:
- MacOS
- Ubuntu 20.04
- Windows 10
## Blockchain compatibility
- Bloxberg:
- Testnet - tested and working
- Mainnet - to be provided during the following updates
- Polyhon:
- Amoy Testnet - to be provided during the following updates
- Mainnet - to be provided during the following updates
### Scripts
- **Initialize**: To initialize the project, run:
```sh
npm run ecld-init
```
at this step, all the initial configurations will be set up and the project will be ready to be built, published and run.
- **Build**: To build the project, run:
```sh
npm run ecld-build
```
the project will be built and the docker repository output will be stored in the `registry/` directory. This is the stage where the backend functions are added to the secure images.
- **Publish**: To publish the project, run:
```sh
npm run ecld-publish
```
Required after build, to build and integrate the secure certificates that will be used during executions and to register the project to the Ethernity Cloud Image Register.
- **Run**: To run the project, run:
```sh
npm run start
```
command to start the demo application and test the integration.
## Project Structure
```
.gitignore
build.js
build.sh
demo/
init.js
nodenithy/
package.json
postinstall.js
publish.js
pynithy/
```
### Notable Directories and Files
- **[`build.js`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Fbuild.js%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/build.js")**: Script to build the project.
- **[`init.js`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Finit.js%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/init.js")**: Script to initialize the project.
- **[`publish.js`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Fpublish.js%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/publish.js")**: Script to publish the project.
- **[`postinstall.js`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Fpostinstall.js%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/postinstall.js")**: Script that runs after the package is installed.
- **[`nodenithy/`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Fnodenithy%2F%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/nodenithy/")**: Contains various scripts and modules for the project.
- **[`pynithy/`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fbullet%2Fethernity%2Fethernity-cloud-sdk-js%2Fpynithy%2F%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "/Users/bullet/ethernity/ethernity-cloud-sdk-js/pynithy/")**: Contains Python-related scripts and configurations.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.