https://github.com/crazyoptimist/lambda-template-typescript

A Node.js lambda service template written in Typescript
https://github.com/crazyoptimist/lambda-template-typescript

Last synced: 13 days ago
JSON representation

A Node.js lambda service template written in Typescript

• Host: GitHub
• URL: https://github.com/crazyoptimist/lambda-template-typescript
• Owner: crazyoptimist
• Created: 2023-08-08T19:24:03.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-31T07:17:11.000Z (about 1 year ago)
• Last Synced: 2024-10-03T21:41:14.859Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 1.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Serverless Template Typescript

This is a serverless template written in Typescript.

## Style Guide

### Project Structure

- `src/functions` is where we organize serverless functions for this service. Keep function files as simple as possible and organize broken down business logics inside `src/helpers`.

- `src/helpers` is where we organize broken-down modules that runs business logics, create sub folders if needed.

- `src/config` is where we organize application global configurations and constants. Every environment variables should be verified(and maybe re-organized as nested objects if we prefer) in `src/config`. We should not read env vars directly like `process.env.FOO`, because it's hard to track what's used where.

- `src/utils` is where we organize utility functions that doesn't contain any business logics

- `src/common` is where we organize shared code which is reused and is shared between different modules, and is specific to this project. Create sub folders if needed.

- `src/scripts` is where we organize one-off scripts.

- `testdata` is where test sample data live. Create sub folders as needed.

### Naming Conventions

- Use `kebab-case` for folders

- Use `camelCase` for variables, functions, and files

- Use `PascalCase` for classes, types, interfaces, enums

- Use `ALL_UPPER_CASE` for constants

### Tests

- Place test files in the same folder as the code that the tests are written for.

## Development

- Node.js(> v18.x) is required

- Install dependencies

  ```bash

  npm i

  ```

- Run the application

  ```bash

  npm run dev

  ```

## Logging

- Structured logging for lambda functions is setup using `pino` and `pino-lambda`.

- We can import logger from `src/utils/logger` and use it anywhere in the application.