This package provides support for working with Spheron Web-App organization.
Usage
The package exports SpheronClient class, which includes methods for working with organizations, projects, deployments and their configurations. The constructor of SpheronClient takes in one parameter token. Check the Access Token section for information on how to create a token.
import { SpheronClient } from"@spheron/site";
...
const spheron = newSpheronClient({ token });
await spheron.deployments.deploy({
gitUrl, // the url of the repository
projectName, // if the project for the repository does not exists, a new project will be created with this nameenvironmentVariables: {
KEY_1: "value1",
},
provider: ProviderEnum.GITHUB, // the provider of the git urlbranch: "main", // the branch name that should be deployedprotocol: ProtocolEnum.IPFS, // the protocol on which the deployment should be uploadedconfiguration: {
framework: FrameworkEnum.REACT,
workspace: "",
installCommand: "yarn install",
buildCommand: "yarn build",
publishDir: "build",
nodeVersion: NodeVersionEnum.V_16,
},
});
For more information about the Site methods, check out the DOCS
Access Token
To create the token that is used with the SpheronClient, follow the instructions in the DOCS. When you are creating the tokens, please choose web app type in the dashboard.
Learn More
You can learn more about Spheron and Storage SDK here:
Typescript library for working with Spheron Web-App Organizations.
We found that @spheron/site demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 5 open source maintainers collaborating on the project.
Package last updated on 11 Sep 2023
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.