Giter Club home page Giter Club logo

otlichnyy / sls-node-ts-template Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 156 KB

SLS-Node-TS-Template repository! This project provides a robust boilerplate for developing serverless applications on AWS Lambda using Express.js and TypeScript. It combines the power of Express.js for building APIs with the benefits of TypeScript for static typing and modern JavaScript features.

JavaScript 2.98% TypeScript 97.02%
aws boilerplate production-ready serverless

sls-node-ts-template's Introduction

๐Ÿš€ SLS-Node-TS-Template

License: ISC

The production-ready boilerplate to develop serverless applications on AWS Lambda with Express.js in TypeScript. Build Apps Locally

๐Ÿ“ฆ Features

  • Express.js Integration: Build robust serverless APIs with the power of Express.js.
  • TypeScript Support: Enjoy the benefits of static typing and modern JavaScript features.
  • Serverless Framework: Utilize the Serverless Framework for seamless deployment and management of AWS Lambda functions.
  • ESLint and Prettier: Maintain code quality and consistency with ESLint and Prettier configurations.
  • Jest Testing: Write and run tests with Jest to ensure the reliability of your serverless functions.
  • Serverless Plugins: Leverage useful Serverless plugins like serverless-dotenv-plugin, serverless-esbuild, serverless-lift, and serverless-offline.
  • Deployment-ready: A template ready for production deployment on AWS Lambda.
  • Dynamodb-local This support DyanamoDB local Developement
  • Proper Global Error Handling: Express's global error handling with error stacks on developement and production envs (make sure to add NODE_ENV=developement to see error stacks in response)

๐Ÿ› ๏ธ Prerequisites

  • Node.js (v18.19.0 recommended)
  • npm or yarn
  • volta (node and package manager, recommended)
  • Serverless Framework (v3.38.0 or later)

๐Ÿšฆ Getting Started

  1. Clone the Repository:

    git clone [email protected]:otlichnyy/sls-node-ts-template.git
    cd sls-node-ts-template
  2. Install Dependencies:

    npm install
  3. Local Development:

    npx sls offline
  4. Testing:

    npm t
  5. Linting and Formatting:

    npm run lint
  6. Deploy:

    npx sls deploy

๐Ÿ“„ License

This project is licensed under the ISC License - see the LICENSE file for details.

sls-node-ts-template's People

Contributors

otlichnyy avatar

Stargazers

 avatar

Watchers

 avatar

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.