Skip to content

Latest commit

 

History

History
139 lines (92 loc) · 3.95 KB

README.md

File metadata and controls

139 lines (92 loc) · 3.95 KB
Raw

Ts.ED logo

Ts.ED - tsed-aws-lambda


Website   •   Getting started   •   Slack   •   Twitter

An awesome project based on Ts.ED framework

Features

  • Yarn 4 workspaces
  • AWS Lambda
  • Terraform
  • Ts.ED - Serverless and Fullstack framework

Getting started

This project requires some tools to be installed on your machine. Here is a list of the tools you need to install:

Installation

# install dependencies
yarn install

Development

Lambda

This command start the lambda function locally.

yarn start:lambda
  • It builds all lambda and create Zip file in the dist folder.
  • It deploys the lambda function on localstack (on start and on file change)

Full Express.js server

Start full Express.js server:

# start web server
yarn start:www

Generate Swagger API documentation

yarn build:swagger

This command use the packages/www to generate documentation

Run tests

To run all tests over the workspace:

yarn test

To run tests for a specific package:

yarn test:lambda
yarn test:controllers

Run E2E tests (dev)

Add the following environment variables to your .env.local file:

LOCALSTACK_AUTH_TOKEN=<YOUR_LOCALSTACK_AUTH_TOKEN>

To run E2E tests:

yarn start:lambda
yarn test:e2e

Deployment

Use terraform to deploy the lambda function on AWS.

yarn build:lambda
yarn deploy:lambda

Contributors

Please read contributing guidelines here.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - Today Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.