This template provides a ready-to-use boilerplate for deploying serverless applications to AWS Lambda and API Gateway. It's built with Express for handling HTTP requests and TypeScript for type safety and improved code quality.
You could fork this repository, but for an even easier setup, you can use the Serverless Framework's install command. This template includes pre-configured settings for linting, type-checking, and more, making it an ideal starting point for Serverless-Express-TypeScript projects.
First, download this boilerplate to your local machine using the following command:
serverless install -u https://github.com/46ki75/aws-node-typescript-express -n my-projectNote: my-project is a placeholder. Replace it with the name you want for your new project.
Navigate to the root folder of your new project and install the necessary npm packages:
cd my-project # Replace "my-project" with your chosen project name
npm installBefore deploying your project, it's crucial to compile the TypeScript files into JavaScript. This ensures that all type checks are passed, and the code is ready for production. You can achieve this by running the following npm command:
npm run buildThis command compiles all TypeScript files in the src directory to JavaScript, outputting them into the dist directory. The dist directory is then used during the deployment process. Make sure to run this command every time you make changes to your TypeScript files and intend to deploy those changes.
Initialize the Serverless Framework to set up your new project:
serverlessDuring this initialization process, you will be asked if you want to deploy the project. Before proceeding with the deployment, make sure to build the project using npm run build to compile the TypeScript files into JavaScript. Otherwise, you may encounter issues during the deployment.
To run the Express server in your local environment, use:
npm startThis command will automatically compile the TypeScript files into JavaScript and then start the server on a predefined port. Once started, the server will be accessible via a browser or Postman.
For a more productive development experience, use live reloading with nodemon:
npm run devThis command will start the server and watch for changes in your source files, automatically reloading the server when changes are detected.
| File | Description |
|---|---|
src/index.ts |
Defines and exports the root handler for the Express application. It comes with minimal setup, allowing you to add various logic as you see fit. |
src/server.ts |
This file enables you to run the Express server in a local environment. |
src/lambda.ts |
Exports the handler to be passed to AWS Lambda. This handler wraps your Express application for serverless deployment. |
serverless.yml |
The configuration file for the Serverless Framework. It contains all the settings needed for deploying your service to AWS Lambda and API Gateway. |
This section gives you an overview of the core files in the project, each serving a specific purpose to make the serverless deployment as smooth as possible. For instance, src/index.ts serves as the entry point for your Express application, but it's flexible enough for you to extend its functionalities. src/server.ts is useful for local testing and development, whereas src/lambda.ts prepares your application for serverless deployment.