Gitingest

Include files under: 50kB

Private Repository NEW

Summary

Repository: fdaciuk/boilerplate-nodejs-typescript-serverless
Files analyzed: 19

Estimated tokens: 4.7k

Download

Directory Structure

Directory structure:

└── fdaciuk-boilerplate-nodejs-typescript-serverless/

    ├── README.md

    ├── deploy-local.sh

    ├── docker-compose.yml

    ├── package.json

    ├── serverless.local.yml

    ├── serverless.yml

    ├── tsconfig.json

    ├── .editorconfig

    ├── .eslintrc.js

    ├── .nvmrc

    ├── prisma/

    │   └── schema.prisma

    ├── src/

    │   ├── config/

    │   │   └── update-deps.ts

    │   └── functions/

    │       ├── fastify-server.ts

    │       └── index.ts

    ├── .github/

    │   └── workflows/

    │       ├── ci-cd.yml

    │       ├── generate-tag.yml

    │       ├── manual-deployment-by-branch.yml

    │       └── manual-deployment-by-tag.yml

    └── .husky/

        └── pre-commit

Files Content

================================================
FILE: README.md
================================================
# Boilerplate Node.js + TypeScript for Serverless

> WIP - Boilerplate Node.js + TypeScript + Prisma + Serverless

## Setup

### Update project information

- In `serverless.yml`, update `service` field with the name of your project;
- In `package.json`, update `name` field with the name of your project;

### Choose your database

To use with **Planet Scale** (MySQL serverless DB), you can use this env config:

```zsh
DB_USER=mysqluser
DB_ROOT_USER=root
DB_PASSWORD=mysqlpass
DB_HOST=0.0.0.0
DB_PORT=3306
DB_DATABASE=mydb
DATABASE_URL="mysql://${DB_ROOT_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}"
```

To use with Mongo Atlas serverless, use this env config:

```zsh
DB_USER=mongodbuser
DB_PASSWORD=mongodbpass
DB_HOST=mongodbhost
DB_DATABASE=db
DATABASE_URL="mongodb+srv://${DB_USER}:${DB_PASSWORD}@${DB_HOST}/${DB_DATABASE}?retryWrites=true&w=majority"
```

To use with MongoDB local (docker-compose), use this env config:

```zsh
DB_USER=mongodbuser
DB_PASSWORD=mongodbpass
DB_HOST=0.0.0.0
DB_PORT=27017
DB_DATABASE=db
DATABASE_URL="mongodb://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}?authSource=admin&retryWrites=true&w=majority"
```

### Local server

If you are using mongodb, you need to create TypeScript types to use with Prisma. Just run the command:

```zsh
yarn generate
```

Get the docker up with the command:

```zsh
DEBUG=1 yarn docker:up:logs
```

With this command, you can see if something is wrong by looking at the logs.
You can use `Ctrl + C` any time to came back to your terminal prompt without
get the process down.

To get the docker down, you will have to use the command:

```zsh
yarn docker:down
```

After the docker is up and running, just get your server up with the following command:

```zsh
yarn dev
```

### Deploy

WIP

### Custom domain

WIP



================================================
FILE: deploy-local.sh
================================================
#!/bin/bash
echo "Ajustando configuração..."
mv serverless.yml serverless.yml.bkp
mv serverless.local.yml serverless.yml
echo "Configuração ajustada!"
echo "Iniciando deploy..."

yarn deploy:local

echo "Deploy finalizado!"
echo "Finalizando configuração..."
mv serverless.yml serverless.local.yml
mv serverless.yml.bkp serverless.yml
echo "Configuração finalizada!"




================================================
FILE: docker-compose.yml
================================================
version: "3.8"
services:
  localstack:
    container_name: "${LOCALSTACK_DOCKER_NAME-localstack_main}"
    image: localstack/localstack
    ports:
      - "127.0.0.1:4566:4566"            # LocalStack Gateway
      - "127.0.0.1:4510-4559:4510-4559"  # external services port range
    environment:
      - DEBUG=${DEBUG-}
      - PERSISTENCE=${PERSISTENCE-}
      - LAMBDA_EXECUTOR=${LAMBDA_EXECUTOR-}
      - DOCKER_HOST=unix:///var/run/docker.sock
    volumes:
      - "${LOCALSTACK_VOLUME_DIR:-/tmp/volume}:/var/lib/localstack"
      - "/var/run/docker.sock:/var/run/docker.sock"

  mongo:
    # This image automatically creates a replica set required for transactions
    image: prismagraphql/mongo-single-replica:4.4.3-bionic
    environment:
      MONGO_INITDB_ROOT_USERNAME: ${DB_USER}
      MONGO_INITDB_ROOT_PASSWORD: ${DB_PASSWORD}
      INIT_WAIT_SEC: 3
    ports:
      - 27017:27017



================================================
FILE: package.json
================================================
{
  "name": "my-service",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    "dev": "npm run start:server",
    "test": "echo 1",
    "start:server": "serverless offline start --stage local",
    "docker:up": "docker-compose up -d",
    "docker:up:logs": "yarn docker:up && docker-compose logs -f",
    "docker:down": "docker-compose down",
    "docker:destroy": "docker-compose down --volumes --remove-orphans",
    "deploy:local": "serverless deploy --stage local",
    "deploy:dev": "serverless deploy --stage dev",
    "deploy": "serverless deploy",
    "generate": "prisma generate",
    "lint": "eslint . --ext js,ts",
    "lint:fix": "eslint --fix . --ext js,ts",
    "type-check": "tsc --project tsconfig.json --pretty --noEmit",
    "prepare": "husky install",
    "ci": "yarn lint && yarn type-check && yarn test",
    "check-lint-type": "yarn lint:fix && yarn type-check",
    "update-deps": "sucrase-node ./src/config/update-deps.ts"
  },
  "engines": {
    "node": ">=16 <17"
  },
  "dependencies": {
    "@fastify/aws-lambda": "3.1.3",
    "@prisma/client": "4.3.1",
    "fastify": "4.5.3"
  },
  "devDependencies": {
    "@types/node": "18.7.18",
    "@typescript-eslint/eslint-plugin": "5.36.2",
    "@typescript-eslint/parser": "5.36.2",
    "eslint": "8.23.0",
    "eslint-config-standard": "17.0.0",
    "eslint-plugin-import": "2.26.0",
    "eslint-plugin-jest": "27.0.4",
    "eslint-plugin-n": "15.2.5",
    "eslint-plugin-promise": "6.0.1",
    "husky": "8.0.1",
    "prisma": "4.3.1",
    "serverless": "3.22.0",
    "serverless-bundle": "5.5.0",
    "serverless-domain-manager": "6.1.0",
    "serverless-dotenv-plugin": "4.0.2",
    "serverless-localstack": "1.0.0",
    "serverless-offline": "10.0.1",
    "sucrase": "3.25.0",
    "typescript": "4.8.3"
  }
}



================================================
FILE: serverless.local.yml
================================================
service: my-service

provider:
  name: aws
  runtime: nodejs16.x
  region: us-east-1
  memorySize: 256
  apiGateway:
    shouldStartNameWithService: true

  iam:
    role:
      statements:
        - Effect: Allow
          Action:
            - lambda:*
          Resource: '*'

  environment:
    ENVIRONMENT: ${opt:stage, 'local'}

package:
  individually: true

functions:
  name_of_the_function:
    handler: src/functions/index.handler
    events:
      - http:
          method: get
          path: hello
          cors: true

custom:
  # localstack
  localstack:
    stages:
      - local
    host: http://0.0.0.0

  # serverless-bundle
  bundle:
    sourcemaps: true

plugins:
  - serverless-localstack
  - serverless-bundle
  - serverless-offline



================================================
FILE: serverless.yml
================================================
service: my-service

provider:
  name: aws
  runtime: nodejs16.x
  region: us-east-1
  memorySize: 256
  httpApi:
    payload: '2.0'
    shouldStartNameWithService: true
    metrics: true
    cors: true

  iam:
    role:
      statements:
        - Effect: Allow
          Action:
            - lambda:*
            - ssm:*
            - secretmanager:*
          Resource: '*'

  environment:
    ENVIRONMENT: ${opt:stage, 'local'}
    DATABASE_URL: ${ssm:my-service-database-url-${opt:stage, 'dev'}, env:DATABASE_URL}

package:
  individually: true

functions:
  name_of_the_function:
    handler: src/functions/index.handler
    events:
      - httpApi: '*'

custom:
  # localstack
  localstack:
    stages:
      - local
    host: http://0.0.0.0

  # serverless-bundle
  bundle:
    sourcemaps: true

  # serverless-domain-manager
  # customDomain:
  #   domainName: serverless.foo.com
  #   stage: ${opt:stage, 'dev'}
  #   basePath: ''
  #   certificateName: '*.foo.com'
  #   createRoute53Record: true
  #   createRoute53IPv6Record: true
  #   endpointType: 'regional'
  #   securityPolicy: tls_1_2
  #   apiType: http
  #   autoDomain: false

plugins:
  - serverless-localstack
  - serverless-bundle
  - serverless-offline
  # - serverless-domain-manager
  - serverless-dotenv-plugin



================================================
FILE: tsconfig.json
================================================
{
  "compilerOptions": {
    "incremental": true,
    "target": "ESNext",
    "module": "ES6",
    "sourceMap": true,
    "outDir": "./dist",
    "rootDir": "./",
    "lib":  ["ESNext", "ESNext.AsyncIterable"],
    "noEmit": true,

    "strict": true,

    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    "noUncheckedIndexedAccess": true,
    "noPropertyAccessFromIndexSignature": true,
    "strictPropertyInitialization": false,

    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,

    "moduleResolution": "node",
    "baseUrl": ".",
    "paths": {
      "@/*": ["./src/*"]
    },
    "rootDirs": ["./src"],
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "resolveJsonModule": true,

    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },

  "include": [
    "**/*.ts"
  ],
  "exclude": [
    "node_modules",
    "dist"
  ]
}



================================================
FILE: .editorconfig
================================================
root = true

[*]
indent_size = 2
indent_style = space
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf

[*.md]
trim_trailing_whitespace = false



================================================
FILE: .eslintrc.js
================================================
module.exports = {
  env: {
    es2021: true,
    node: true,
  },
  extends: [
    'plugin:jest/recommended',
    'standard',
  ],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaVersion: 12,
    sourceType: 'module',
  },
  plugins: [
    '@typescript-eslint',
  ],
  rules: {
    quotes: ['error', 'single', { allowTemplateLiterals: true }],
    indent: ['error', 2, {
      SwitchCase: 1,
      ignoredNodes: ['PropertyDefinition'],
    }],
    'no-useless-constructor': 'off',
    'comma-dangle': ['error', {
      arrays: 'always-multiline',
      objects: 'always-multiline',
      imports: 'always-multiline',
      exports: 'always-multiline',
      functions: 'always-multiline',
    }],
    camelcase: 'off',
    'no-warning-comments': 'warn',
    'react/react-in-jsx-scope': 'off',
    'react/prop-types': 'off',
    'no-unused-vars': 'off',
    '@typescript-eslint/no-explicit-any': 'off',
    '@typescript-eslint/no-unused-vars': [
      'off', {
        ignoreRestSiblings: true,
        argsIgnorePattern: '^_',
      },
    ],
  },
}



================================================
FILE: .nvmrc
================================================
v16



================================================
FILE: prisma/schema.prisma
================================================
// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

model Post {
  id        String     @id @default(auto()) @map("_id") @db.ObjectId
  slug      String     @unique
  title     String
  body      String
  comments  Comment[]
  author    User       @relation(fields: [authorId], references: [id])
  authorId  String     @db.ObjectId
}

// Comments contain a comment string and connect back to the post.
// postId must have @db.ObjectId to match up with Post's id type
model Comment {
  id       String  @id @default(auto()) @map("_id") @db.ObjectId
  post     Post    @relation(fields: [postId], references: [id])
  postId   String  @db.ObjectId
  comment  String
}

model User {
  id     String   @id @default(auto()) @map("_id") @db.ObjectId
  email  String   @unique
  name   String?
  posts  Post[]
}



================================================
FILE: src/config/update-deps.ts
================================================
import { spawn } from 'child_process'
import pkg from '../../package.json'

const dependencies = Object.keys(pkg.dependencies)
const devDependencies = Object.keys(pkg.devDependencies)

const add = (args: string[]) => {
  return spawn('yarn', ['add', '--exact'].concat(args), { stdio: 'inherit' })
}

add(dependencies).on('close', () => {
  add(['--dev'].concat(devDependencies))
    .on('close', (code) => process.exit(Number(code)))
})



================================================
FILE: src/functions/fastify-server.ts
================================================
import fastify from 'fastify'
import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

const app = fastify()

app.get('/', async (_req, reply) => {
  const databaseUrlString = 'DATABASE_URL'
  console.log('process.env.DATABASE_URL', process.env[databaseUrlString])
  const newUser = await prisma.user.create({
    data: {
      email: 'user@email.com',
      name: 'The user',
    },
  })
  console.log('\n\n\n', newUser, '\n\n\n')
  reply.send({ hello: 'world' })
})

export { app }



================================================
FILE: src/functions/index.ts
================================================
import awsLambdaFastify from '@fastify/aws-lambda'
import { app } from './fastify-server'

export const handler = awsLambdaFastify(app)



================================================
FILE: .github/workflows/ci-cd.yml
================================================
name: CI
on:
  pull_request:

jobs:
  ci:
    name: Checkout and Install dependencies
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-

      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: 16.x

      - name: Install dependencies
        run: yarn

      - uses: actions/cache@v2
        id: restore-build
        with:
          path: ./*
          key: ${{ github.sha }}

      - name: Type Checking and Linting
        run: yarn check-lint-type

      - name: Test
        run: yarn test --ci



================================================
FILE: .github/workflows/generate-tag.yml
================================================
name: Generate tag version
on:
  workflow_dispatch:
    inputs:
      version:
        description: New version
        required: true
        default: 'patch'
        type: choice
        options:
          - patch
          - minor
          - major

jobs:
  version:
    name: Create new version ${{ github.event.inputs.version }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: main
      - run: |
          git config user.name github-actions
          git config user.email github-actions@github.com

      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: 16.x

      - name: Generate new version
        run: npm version ${{ github.event.inputs.version }}

      - name: Push new version tag to repository
        run: git push origin main --tags



================================================
FILE: .github/workflows/manual-deployment-by-branch.yml
================================================
name: Manual Deployment by Branch
on:
  workflow_dispatch:
    inputs:
      branch:
        description: Branch to deploy
        required: true
      env:
        description: Environment to deploy
        required: true
        default: 'dev'
        type: choice
        options:
          - dev
          - qa
          - prod

jobs:
  deploy:
    name: Deploy branch ${{ github.event.inputs.branch }} to ${{ github.event.inputs.env }} env
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: ${{ github.event.inputs.branch }}
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: 16.x
      - run: yarn

      - name: Type Checking and Linting
        run: yarn check-lint-type

      - name: Run Tests
        run: yarn test --ci

      - name: Deploy to ${{ github.event.inputs.env }} environment
        run: yarn deploy --stage ${{ github.event.inputs.env }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}



================================================
FILE: .github/workflows/manual-deployment-by-tag.yml
================================================
name: Manual Deployment by Tag
on:
  workflow_dispatch:
    inputs:
      tag:
        description: Tag version
        required: true
      env:
        description: Environment to deploy
        required: true
        default: 'dev'
        type: choice
        options:
          - dev
          - qa
          - prod

jobs:
  deploy:
    name: Deploy tag ${{ github.event.inputs.tag }} to ${{ github.event.inputs.env }} env
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: ${{ github.event.inputs.tag }}
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: 16.x
      - run: yarn

      - name: Type Checking and Linting
        run: yarn check-lint-type

      - name: Run Tests
        run: yarn test --ci

      - name: Deploy to ${{ github.event.inputs.env }} environment
        run: yarn deploy --stage ${{ github.event.inputs.env }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}



================================================
FILE: .husky/pre-commit
================================================
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

yarn type-check && yarn lint