Socket
Book a DemoInstallSign in
Socket

@spheron/site

Package Overview
Dependencies
Maintainers
5
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
Package was removed
Sorry, it seems this package was removed from the registry

@spheron/site

Typescript library for working with Spheron Web-App Organizations.

1.0.2
unpublished
latest
Source
npmnpm
Version published
Maintainers
5
Created
Source

Spheron

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:

Keywords

Storage

FAQs

Package last updated on 11 Sep 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.