Giter VIP home page Giter VIP logo

finn-auto / create-full-sls-app Goto Github PK

View Code? Open in Web Editor NEW
8.0 2.0 1.0 138 KB

Serverless boilerplate CLI tool: GitLab and GitHub CI/CD, DataDog, Multi-Region, and many more setups.

Home Page: https://www.npmjs.com/package/create-full-sls-app

License: MIT License

JavaScript 56.69% TypeScript 42.24% Shell 1.07%
serverless aws aws-lambda typescript datadog sentry nodejs yup-validation husky-hooks sonarcloud

create-full-sls-app's Introduction

Serverless Full Boilerplate

This is a CLI tool to create Serverless boilerplate applications. Ready to deploy in a few seconds.

Usage

npm i -g create-full-sls-app
create-full-sls-app

or

npx create-full-sls-app

Answer the questions. It will create a directory of with the name you gave for your project.

cd your-project-name

yarn
yarn domain:create:dev
yarn deploy:dev

or run in your local:

yarn start:local

What's included?

Command Options List

name type default description
template choices serverless-full-sls-app
name strict-string required Project name (e.g dummy-service)
organization strict-string required Organization name (e.g finn-auto)
gitSetup choices GitLab Options: GitLab, GitHub
mainBranch choices main Options: main, master
enableSonarCloud bool Y Setup SonarCloud (Y/n)
enableMultiRegion bool Y Add us-east-1 and enable multi-region (Y/n)
enableDataDog bool Y Enable DataDog in the setup (Y/n)
dataDogArnEuCentral string empty DataDog EU ARN (only if DataDog is enabled)
dataDogArnUsEast string empty DataDog US ARN (only if DataDog and multi-region is enabled)
memorySize number 256 Memory Size of Lambda in MB
timeout number 10 Timeout of API endpoints in seconds
minimumCompressionSize number 1024 Minimum Compression Size of API Gateway in MB
maxRequestsPerSecond number 100 API Gateway Throttling Maximum Requests Per Second setting
maxConcurrentRequests number 50 API Gateway Throttling Maximum Concurrent Requests setting
developmentUrl string dev-service.domain.com Development service URL
productionUrl string service.domain.com Production service URL

Example:

npx create-full-sls-app --template=serverless-full-sls-app --name=dummy-name --organization=dummy-org --gitSetup=GitLab --mainBranch=main --enableSonarCloud --enableMultiRegion --enableDataDog --dataDogArnEuCentral=dummyArn --dataDogArnUsEast=dummyArn --memorySize=1024 --timeout=20 --minimumCompressionSize=1024 --maxRequestsPerSecond=200 --maxConcurrentRequests=50 --developmentUrl=dev-service.domain.com --productionUrl=service.domain.com

Development

yarn build
yarn start

Contribution

Feel free to create a PR to add a new feature or update the current tool. :)


Author: FINN

create-full-sls-app's People

Contributors

ebsaral avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

rafaldana

create-full-sls-app's Issues

Setup secure Access-Control-Allow-Origin for production

Situation

Currently, Access-Control-Allow-Origin is set to '*' in the template which means that the service is public. This is a security issue.

Requirements

  • Setup production domain (at least provide an option) for Access-Control-Allow-Origin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.