Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mingderwang/serverless-esbuild-test
serverless-esbuild testing
https://github.com/mingderwang/serverless-esbuild-test
Last synced: 3 days ago
JSON representation
serverless-esbuild testing
- Host: GitHub
- URL: https://github.com/mingderwang/serverless-esbuild-test
- Owner: mingderwang
- License: mit
- Created: 2022-02-26T07:21:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T10:06:19.000Z (over 1 year ago)
- Last Synced: 2023-04-17T12:52:01.886Z (over 1 year ago)
- Language: TypeScript
- Size: 517 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](http://www.serverless.com)  [](https://github.com/semantic-release/semantic-release)
# Serverless Esbuild Template
This is a template repository to get you started really quickly with the serverless framework and typescript, using the incredible esbuild.
It is slighlty opinionated.
## TL:DR => How to use
```bash
# Make sure you have a modern node environment (example: node 14+, yarn)
# Make sure you have AWS credentials https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html
# Install dependencies
yarn
# Make sure everything works ™
yarn test
# Bundle your code and deploy it (This creates the needed AWS resources, Lambda, apiGw, s3...)
# Deploy will output the URL, refer to serverless documentation to see how everything gets mapped from the serverless.yml
# Everything is configurable, the default stage is dev, and default region is us-east-1
yarn deploy
# Example using curl to test your deployed lambda (make sure to use the correct url)
curl https://00000000.execute-api.us-east-1.amazonaws.com/dev/hello | jq
# Remove service (Removes everything created by sls deploy)
yarn remove
```
## Features
### ⚡ serverless + esbuild = ❤
- Built on top of the incredible [esbuild](https://github.com/evanw/esbuild), mad props to [@evanw](https://github.com/evanw)
- Refer to [serverless-esbuild](https://github.com/floydspace/serverless-esbuild) for the plugin documentation, credits to [@floydspace](https://github.com/floydspace)
- Includes the amazing [esbuild-register](https://github.com/egoist/esbuild-register), thanks to [@egoist](https://github.com/egoist)
```bash
node -r esm -r esbuild-register script.ts #Aliased to TS for your convenience
```
> Enjoy lighting fast build and script execution in typescript
### ⚙ Eslint / Prettier / Typescript / Yarn / dotenv
With sensible defaults because writing boilerplate takes too much time.
> _dotenv is intentionally a dev dependencies, if you want to use it at runtime, move it to dependencies, import it in your code then load your env file._
### 🧪 Tests with Jest, GitHub Actions, Dependabot
An example of an integration test that works with the great `sls offline` and the node-fetch package.
Simply run :
```bash
yarn test
```
> A Github Action basic pipeline is setup with yarn caching and tests, check .github/workflows/main.yaml
### 📴 Serverless-offline dev/start/stop scripts with pm2
pm2 is a node process manager, very handy when you're dealing with several local microservices ...
```json
{
"offline:dev": "yarn ts scripts/offline.ts dev",
"offline:start": "yarn ts scripts/offline.ts start",
"offline:stop": "yarn ts scripts/offline.ts stop"
}
```
- `offline:dev` : Start `sls offline` in the foreground.
- `offline:start` : Start `sls offline` in the background with pm2, log the output to pm2.log
- `offline:stop` : Terminate the pm2 process(es) cleanly (based on the name, check offline.ts)
Check offline.ts if you need custom behavior.
### 🌀 Serverless.ts
Use a serverless.ts files instead of a serverless.yml file for the configuration.
You can delete the serverless.ts and rename serverless.example.yml to serverless.yml if you prefer yaml.
Refer to the [docs](https://www.serverless.com/framework/docs/providers/aws/guide/intro/).
More info in the [PR](https://github.com/serverless/serverless/pull/7755).
> View this repository on GitHub: