chore: add scaffold

Author: fdorantesm

.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*"
+]

.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
+

.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

.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',
+  },
+};

.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)

.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

.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

.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

.nvmrc

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

.prettierrc

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