chore: add scaffold

Author: fdorantesm

Diff for: .deepsource.toml

@@ -0,0 +1,19 @@
+version = 1
+
+[[analyzers]]
+enabled = true
+name = "javascript"
+
+[[transformers]]
+enabled = true
+name = "prettier"
+
+test_patterns = [
+  "test/**/*",
+  "**/*.spec.ts"
+]
+
+exclude_patterns = [
+  "**/node_modules/",
+  "**/*memory*"
+]

Diff for: .editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# The JSON files contain newlines inconsistently
+[*.json]
+insert_final_newline = ignore
+
+[*.md]
+trim_trailing_whitespace = false
+

Diff for: .env.example

@@ -0,0 +1,37 @@
+# Environment
+NODE_ENV=development
+
+# Server
+HOST=localhost
+PORT=3331
+RATE_MAX_REQUEST=100
+RATE_INTERVAL=1000
+
+# Database
+DB_HOST=localhost
+DB_PORT=27125
+DB_USERNAME=root
+DB_PASSWORD=secret
+DB_DATABASE=app
+
+# JWT
+JWT_EXPIRES=365d
+JWT_SECRET=secret
+
+# S3
+S3_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE
+S3_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+S3_BUCKET=default
+S3_ENDPOINT=http://127.0.0.1:9000
+
+SES_FROM=[email protected]
+SES_REGION=us-east-1
+SES_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE
+SES_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+SES_BCC=
+
+# Docker Registry
+DOCKER_REGISTRY_URI=registry.example.com
+
+# Docker Compose
+COMPOSE_PROJECT_NAME=nestjs-mongodb-hexagonal-template

Diff for: .eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:yml/standard',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

Diff for: .github/workflows/build.yml

@@ -0,0 +1,13 @@
+name: Docker Image Build
+
+on:
+  pull_request:
+    branches: [ "main", "develop" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build the Docker image
+      run: docker build . --tag app:$(date +%s)

Diff for: .github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: ["main", "develop"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+    defaults:
+      run:
+        working-directory: .
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install libraries
+        run: yarn install
+      - name: Run linter
+        run: yarn lint

Diff for: .github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  pull_request:
+    branches: ["main", "develop"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+    defaults:
+      run:
+        working-directory: .
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install libraries
+        run: yarn install
+      - name: Run test
+        run: yarn test

Diff for: .gitignore

@@ -128,3 +128,15 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# MacOS
+.DS_Store
+
+# Env files
+.env
+.env.*
+!.env.example
+
+# Docker resources
+.mongodb
+.minio

Diff for: .nvmrc

@@ -0,0 +1 @@
+v.18

Diff for: .prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 96
+}

Diff for: .vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.tabSize": 2,
+  "editor.formatOnSave": true
+}

Diff for: Dockerfile

@@ -0,0 +1,23 @@
+FROM node:16 as build
+
+WORKDIR /src
+
+COPY package.json .
+COPY yarn.lock .
+
+RUN yarn install
+
+COPY . .
+
+RUN yarn build
+RUN rm -rf node_modules
+RUN yarn install --production=true
+
+FROM node:16-alpine as deploy
+
+WORKDIR /app
+
+COPY --from=build /src/dist/ /app
+COPY --from=build /src/node_modules ./node_modules
+
+ENTRYPOINT [ "node", "main.js" ]

Diff for: deploy.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Cargar las variables de ambiente del archivo .env
+if [ -f .env ]; then
+  source .env
+fi
+
+# Obtener el nombre del contenedor a partir del nombre del proyecto de Docker Compose
+CONTAINER_NAME="$COMPOSE_PROJECT_NAME"
+TAG=$1
+
+# Autenticarse en ECR
+AWS_REGION=$(echo "$DOCKER_REGISTRY_URI" | cut -d '.' -f 4)
+DOCKER_REGISTRY_HOST=$(echo "$DOCKER_REGISTRY_URI" | cut -d '/' -f 1)
+aws ecr get-login-password --region "$AWS_REGION" | docker login --username AWS --password-stdin "$DOCKER_REGISTRY_HOST"
+
+docker pull "$DOCKER_REGISTRY_URI:$TAG"
+
+CURRENT_CONTAINER_ID=$(docker ps -qf "name=$CONTAINER_NAME")
+
+if [ -z "$CURRENT_CONTAINER_ID" ]
+    docker stop "$CURRENT_CONTAINER_ID" && docker rm "$CURRENT_CONTAINER_ID"
+then
+    echo "No current container $CONTAINER_NAME"
+fi
+
+shift
+
+TEMP_CONTAINER_NAME="$CONTAINER_NAME-temp"
+
+docker run -d --name "$TEMP_CONTAINER_NAME" "$@" "$DOCKER_REGISTRY_URI:$TAG"
+docker rename "$TEMP_CONTAINER_NAME" "$CONTAINER_NAME"

Diff for: docker-compose.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+
+services:
+  mongodb:
+    container_name: ${COMPOSE_PROJECT_NAME}_mongodb
+    image: mongo:5.0
+    environment:
+      - MONGO_INITDB_DATABASE=app
+      - MONGO_INITDB_ROOT_USERNAME=root
+      - MONGO_INITDB_ROOT_PASSWORD=secret
+    ports:
+      - 27125:27017
+    volumes:
+      - .mongodb:/data/db
+
+  minio:
+    container_name: ${COMPOSE_PROJECT_NAME}_minio
+    image: minio/minio:latest
+    command: server --console-address :9001 /data
+    environment:
+      - MINIO_ROOT_USER=AKIAIOSFODNN7EXAMPLE
+      - MINIO_ROOT_PASSWORD=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+    volumes:
+      - .minio:/data
+    ports:
+      - 9000:9000
+      - 9001:9001

Diff for: docker.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+if [ -z "$DOCKER_REGISTRY_URI" ]; then
+    echo "Error: DOCKER_REGISTRY_URI variable is not defined"
+    exit 1
+fi
+
+if [ -z "$COMPOSE_PROJECT_NAME" ]; then
+    echo "Error: COMPOSE_PROJECT_NAME variable is not defined"
+    exit 1
+fi
+
+get_remote() {
+    echo $(docker image ls --filter "reference=$PUBLISH_TAG" --format "{{.Repository}}:{{.Tag}}")
+}
+
+get_tag() {
+    BRANCH=$(git branch --show-current)
+
+    if [ "$BRANCH" == "main" ] || [ "$BRANCH" == "master" ]; then
+        echo ""
+    elif [ "$BRANCH" == "develop" ]; then
+        echo "develop"
+    else
+        echo "$BRANCH"
+    fi
+}
+
+TAG=$(get_tag)
+VERSION=$(awk -F'"' '/"version": ".+"/{ print $4; exit; }' package.json)
+DOCKER_REGISTRY_HOST=$(echo $DOCKER_REGISTRY_URI | awk -F/ '{print $1}')
+REGION=$(echo $DOCKER_REGISTRY_URI | awk -F[/.] '{print $4}')
+HASH=$(git rev-parse HEAD)
+IMAGE_NAME=$COMPOSE_PROJECT_NAME
+
+if [ -n "$TAG" ]; then
+    IMAGE_NAME="$IMAGE_NAME:$TAG-$HASH"
+    REGISTRY_IMAGE_TAG=$DOCKER_REGISTRY_URI:$TAG
+    PUBLISH_TAG=$REGISTRY_IMAGE_TAG-$HASH
+else
+    IMAGE_NAME="$IMAGE_NAME:$HASH"
+    REGISTRY_IMAGE_TAG=$DOCKER_REGISTRY_URI:$HASH
+    PUBLISH_TAG=$REGISTRY_IMAGE_TAG
+fi
+
+
+if [ -z "$IMAGE_NAME" ]; then
+    echo "There's no local image to delete"
+else
+    docker rmi $IMAGE_NAME
+fi
+
+if [ -z $(get_remote) ]; then
+    echo "There's no remote tag to delete"
+else
+    docker rmi $(get_remote)
+fi
+
+docker build --platform linux/amd64 -t $IMAGE_NAME .
+docker tag $IMAGE_NAME $PUBLISH_TAG
+aws ecr get-login-password --region $REGION --profile $1 | docker login --username AWS --password-stdin $DOCKER_REGISTRY_HOST
+docker push $PUBLISH_TAG
+
+UNTAGGED_IMAGES=$(aws ecr list-images --no-cli-pager --region $REGION --profile $1 --repository-name $COMPOSE_PROJECT_NAME --filter "tagStatus=UNTAGGED" --query 'imageIds[*].[imageDigest]' --output text | sed -e 's/^/imageDigest=/')
+
+if [ -z "$UNTAGGED_IMAGES" ]; then
+    echo "There's no remote images to delete"
+else
+    aws ecr batch-delete-image --no-cli-pager --region $REGION --profile $1 --repository-name $COMPOSE_PROJECT_NAME --image-ids $UNTAGGED_IMAGES >/dev/null
+fi
+
+for image in $(get_remote); do
+    docker rmi -f "$image"
+done

Diff for: libs/common/src/index.ts

@@ -0,0 +1,5 @@
+export * from './types/general/json.type';
+export * from './types/database/database-connnection.type';
+export * from './types/http/http-server.type';
+export * from './types/ses/ses-configuration.type';
+export * from './types/jwt/jwt.configuration';

Diff for: libs/common/src/types/database/database-connnection.type.ts

@@ -0,0 +1,7 @@
+export type DatabaseConnection = {
+  host: string;
+  port?: number;
+  username?: string;
+  password?: string;
+  database?: string;
+};

Diff for: libs/common/src/types/environment/environment.type.ts

@@ -0,0 +1,3 @@
+export type EnvironmentConfig = {
+  nodeEnv: string;
+};

Diff for: libs/common/src/types/general/file.type.ts

@@ -0,0 +1,8 @@
+export type File = {
+  originalname: string;
+  fieldname: string;
+  enconding: string;
+  mimetype: string;
+  buffer: Buffer;
+  size: number;
+};

Diff for: libs/common/src/types/general/json.type.ts

@@ -0,0 +1,3 @@
+export type Json = {
+  [key: string]: any;
+};