Skip to content

Latest commit

 

History

History
110 lines (86 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

110 lines (86 loc) · 3.67 KB
Raw

Contributing

Docs

bridged msa docs on notion bridged msa diagram on figma

About port usage on local environment

for running multuple services via sls offline, we set the difference ports by each services.

  • url service : 4000
  • asset service : 4001
  • build service : 4002
  • build-store service : 4003
  • g11n service : 4004
  • hosting service : 4005
  • project service : 4007
  • resource service : 4008
  • design-store service : 4009
  • scene service : 4010
  • payment service : 4011
  • cors service : 4012
  • proxy analytics service : 4013

NestJS + Yarn workspace + Typescript + Webpack configuration

we are using serverless-bundle , which is an wrapper of webpack + babel + ts loader + node externals for our required stack. but this to work with nestJS seamless, we need extra configurations

serverless.yml

service:
  name: service-name

plugins:
  - serverless-bundle
  - serverless-dynamodb-local
  - serverless-offline
  - serverless-domain-manager

custom:
  bundle:
    caching: false
    forceExclude:
      - '@nestjs/microservices'
      - '@nestjs/microservices/microservices-module'
      - '@nestjs/websockets/socket-module'
      - 'cache-manager'
  customDomain:
    domainName: service-name.bridged.cc
    hostedZoneId: us-west-1
    basePath: ''
    stage: ${self:provider.stage}
    createRoute53Record: true
  serverless-offline:
    httpPort: 4004

Usage of dynamoose

using dynamoose requires dynamodb:DescribeTable permission

provider:
  name: aws
  runtime: nodejs12.x
  region: us-west-1
  apiGateway:
    minimumCompressionSize: 1024
  environment: 
    AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1'
    DYNAMODB_KEY_TABLE: "${self:service}-key-${opt:stage, self:provider.stage}"
  iamRoleStatements:
    - Effect: Allow
      Action:
        - dynamodb:Query
        - dynamodb:Scan
        - dynamodb:GetItem
        - dynamodb:PutItem
        - dynamodb:UpdateItem
        - dynamodb:DeleteItem
        - dynamodb:DescribeTable
      Resource: "arn:aws:dynamodb:${opt:region, self:provider.region}:*:table/${self:provider.environment.DYNAMODB_KEY_TABLE}"

Service Layer Function Naming Conventions

verb forms

  • register: when registering record with a characteristic of key. (when creatting a key, we call it as register key)
  • create: when generally creating a data record
  • add: when adding a component, nested form of data to a object with a characteristic of key. (i.e. register key, add value)
  • put: when creating or updating a data record (when performing http put operation)
  • patch do not use this as a function name
  • update: when updating single / multiple property of data record. (also when performing http patch)
  • get: avoid using this when performing remote data request
  • fetch: when get-ing the data from remote
  • link: when linking two different record as a joint
  • unlink: when disconnecting two different record from a joint
  • remove: opposite of add. when unlinking, and deleting the record
  • delete: when actually, permanatly deeting a data record
  • archive: when removing, but not deleting a data, making it not accessable.