https://github.com/protokol/sst-template

https://github.com/protokol/sst-template

Last synced: about 10 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/protokol/sst-template
• Owner: protokol
• Created: 2022-05-30T11:22:18.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T17:44:39.000Z (11 months ago)
• Last Synced: 2024-04-18T23:24:52.632Z (7 months ago)
• Language: TypeScript
• Size: 115 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#Infrastrucutre

## Install

1. `npm install`

2. Make sure you have setup you AWS credentials and installed AWS CLI. After installing AWS CLI, run `aws configure`.

- https://serverless-stack.com/chapters/configure-the-aws-cli.html

- AWS CLI Install: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

3. Define Local .env file

For guidance - also check `.env.example`. At the current stage it is enough to `cp .env.example .env`

## Running

1. `npm run start` - for more see package.json or look at SST documentation https://docs.serverless-stack.com/

## Testing

You can run tests locally. But you need to deploy first. So for initial development you always work with `npm run start`.

The API tests are independent and reply on serverless stack being deployed first, so:

1. `npm run deploy-with-output` //to generate cdk-output.json, that contains ApiKeys and settings

2. `npm run test` // to execute tests against infra stack