Skip to content

Latest commit

 

History

History
 
 

README.md

How to use PlanetScale

An example serverless API created with SST talking to a PlanetScale Database.

Getting Started

Read the tutorial

Install the example.

$ npx create-sst@latest --template=examples/planetscale
# Or with Yarn
$ yarn create sst --template=examples/planetscale

Commands

yarn run start

Starts the local Lambda development environment.

yarn run build

Build your app and synthesize your stacks.

Generates a .build/ directory with the compiled files and a .build/cdk.out/ directory with the synthesized CloudFormation stacks.

yarn run deploy [stack]

Deploy all your stacks to AWS. Or optionally deploy, a specific stack.

yarn run remove [stack]

Remove all your stacks and all of their resources from AWS. Or optionally removes, a specific stack.

yarn run test

Runs your tests using Jest. Takes all the Jest CLI options.

Documentation

Learn more about SST.

Community

Follow us on Twitter or post on our forums.