The production-ready boilerplate to develop serverless applications on AWS Lambda with Express.js in TypeScript. Build Apps Locally
- 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
, andserverless-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)
- Node.js (v18.19.0 recommended)
- npm or yarn
- volta (node and package manager, recommended)
- Serverless Framework (v3.38.0 or later)
-
Clone the Repository:
git clone [email protected]:otlichnyy/sls-node-ts-template.git cd sls-node-ts-template
-
Install Dependencies:
npm install
-
Local Development:
npx sls offline
-
Testing:
npm t
-
Linting and Formatting:
npm run lint
-
Deploy:
npx sls deploy
This project is licensed under the ISC License - see the LICENSE file for details.