Site SDK
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 = new SpheronClient({ 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 name
environmentVariables: {
KEY_1: "value1",
},
provider: ProviderEnum.GITHUB, // the provider of the git url
branch: "main", // the branch name that should be deployed
protocol: ProtocolEnum.IPFS, // the protocol on which the deployment should be uploaded
configuration: {
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: