sst README

The project's README from github.com/anomalyco/sst. As one markdown file: README.md.

SST

Discord npm Build status

Build full-stack apps on your own infrastructure.

Installation

For JavaScript projects, install SST locally so the CLI version is tracked with your app. You can then run the CLI with the same package manager.

npm install sst
# pnpm add sst
# bun add sst
# yarn add sst

If you are not using JavaScript, you can install the CLI globally.

curl -fsSL https://sst.dev/install | bash

To install a specific version.

curl -fsSL https://sst.dev/install | VERSION=0.0.403 bash

To use a package manager, check out our docs.

Manually

Download the pre-compiled binaries from the releases page and copy to the desired location.

Get Started

Get started with your favorite framework:

Learn More

Learn more about some of the key concepts:

Contributing

Here's how you can contribute:

Running Locally

Run bun run setup. You need Go and Bun installed.

Now you can run the CLI locally on any of the examples/ apps.

cd examples/aws-api
go run ../../cmd/sst <command>

If you want to build the CLI binary, run bun run build:cli. This will create a sst binary that you can use.

For building the docs, run bun run docs:generate and bun run docs:dev.

Join our community Discord | YouTube | X.com

sst (anomalyco/sst)

Searching Database…

26.4K ·GitHub
Sst
What is this?SST is a tool for building full-stack applications that run on your own cloud infrastructure instead of being locked into a vendor's platform. You define your app's infrastructure in code and deploy it yourself.
Is this a CLI tool or a cloud platform?It is a CLI you add to your project: for JavaScript apps you install it locally with your package manager so the CLI version is tracked with the app, and non-JS projects can install it globally or grab a pre-compiled binary.
How do I get started with a project?Install the SST CLI with your package manager (or globally for non-JS projects, or via a pre-compiled binary from the releases page), then follow the get-started guide for your framework of choice.
Which frameworks can I deploy with it?The get-started docs cover Next.js, Remix, Astro, and plain API projects out of the box.
Why deploy on my own infrastructure instead of a managed PaaS?SST's whole premise is deploying full-stack apps directly onto your own cloud infrastructure, so you keep control of the resources powering your app rather than depending on a vendor platform.
What are similar projects?encore, aws-cdk, pulumi, dagger, freebuff, terraformer, opentofu, terraform-provider-aws
Which topics is it in?astro, infrastructure-as-code, full-stack, bun, nextjs, sdk, cloud, devops, go, framework, api, terminal
Creator
anomalyco
Size
165.9 MB
Stars
26.4K
Updated
CommitOct 08Releasev4.17.2Oct 08
Age
6y
Commits · 90 Days