chore(deps): update actions/setup-node action to v4

.circleci/config.yml

@@ -1,12 +1,12 @@
 version: 2.1
 
 orbs:
-  codecov: codecov/codecov@3.2.5
+  codecov: codecov/codecov@3.3.0
 
 jobs:
   test-api:
     docker:
-      - image: cimg/python:3.11.4
+      - image: cimg/python:3.12.0
     steps:
       - checkout
       - run:

.docker/start.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+npx prisma db push --force-reset
+
+if [ $? -eq 0 ]; then
+    echo "Database updated successfully. Running the server 🚀"
+
+    node dist/src/infra/main.js
+else
+    echo "Error updating database. Server will not start."
+fi

.env.development

@@ -1,5 +1,7 @@
 ATABASE_URL="postgresql://admin:admin@db_tms/db_tms?schema=public"
 
+JWT_KEY=12346789
+
 POSTGRES_DB=db_tms
 POSTGRES_USER=admin
 POSTGRES_PASSWORD=admin

.env.example

@@ -1 +1,3 @@
 DATABASE_URL="postgresql://user:password@localhost:5432/mydb?schema=public"
+
+JWT_KEY=

.eslintrc.json

@@ -58,6 +58,18 @@
         "@typescript-eslint/no-misused-promises": "off"
       }
     },
+    {
+      "files": ["**/decorators/**/*"],
+      "rules": {
+        "@typescript-eslint/naming-convention": [
+          "error",
+          {
+            "selector": "variable",
+            "format": ["camelCase", "PascalCase"]
+          }
+        ]
+      }
+    },
     {
       "files": ["test/**"],
       "rules": {
@@ -85,12 +97,6 @@
         "@typescript-eslint/no-var-requires": "off"
       }
     },
-    {
-      "files": "next-seo.config.ts",
-      "rules": {
-        "unicorn/filename-case": "off"
-      }
-    },
     {
       "files": ["**.d.ts"],
       "rules": {
@@ -105,13 +111,13 @@
       }
     },
     {
-      "files": ["src/helpers/*"],
+      "files": ["src/domain/shared/helpers/**"],
       "rules": {
         "@typescript-eslint/naming-convention": "off"
       }
     },
     {
-      "files": ["src/dtos/*"],
+      "files": ["**/dtos/**/*"],
       "rules": {
         "unicorn/filename-case": "off",
         "@typescript-eslint/naming-convention": [
@@ -120,7 +126,7 @@
             "selector": "interface",
             "format": ["PascalCase"],
             "custom": {
-              "regex": "[A-Z]*DTO$",
+              "regex": "^I.*DTO$",
               "match": true
             }
           },
@@ -151,8 +157,13 @@
     "unicorn/no-null": "off",
     "node/no-missing-import": "off",
     "node/no-unpublished-import": "off",
+    "unicorn/no-static-only-class": "off",
     "import/prefer-default-export": "off",
+    "unicorn/prefer-node-protocol": "off",
+    "@typescript-eslint/require-await": "off",
     "@typescript-eslint/no-unsafe-call": "off",
+    "@darraghor/nestjs-typed/injectable-should-be-provided": "off",
+    "@darraghor/nestjs-typed/should-specify-forbid-unknown-values": "off",
     "quote-props": ["error", "consistent-as-needed"],
     "arrow-body-style": ["error", "as-needed"],
     "import/no-duplicates": [

.github/workflows/ci.yml

@@ -11,10 +11,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18.x
 
@@ -28,6 +28,12 @@ jobs:
       - name: Install dependencies
         run: pnpm i --no-frozen-lockfile
 
+      - name: Prisma
+        run: pnpm prisma generate
+
+      - name: Find Dead Code
+        run: pnpm find-deadcode
+
       - name: Linting
         run: pnpm lint
 

.github/workflows/coverage.yml

@@ -1,20 +1,22 @@
 name: Codecov
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+  workflow_run:
+    workflows: [CI]
+    types:
+      - completed
+    branches:
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18.x
 

.github/workflows/release.yml

@@ -15,10 +15,10 @@ jobs:
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18.x
 

.jest/jest.setup.ts

@@ -0,0 +1,3 @@
+import * as dotenv from 'dotenv';
+
+dotenv.config({ path: '.env.test' });

.tool-versions

@@ -1,2 +1,2 @@
 nodejs 19.9.0
-pnpm 8.6.12
+pnpm 8.9.2

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20-alpine As development
+FROM node:20 As development
 
 RUN npm i -g pnpm
 
@@ -34,17 +34,23 @@ RUN pnpm build
 
 ENV NODE_ENV production
 
-RUN pnpm install --prod --ignore-scripts
+RUN pnpm fetch --prod
 
-RUN npx prisma generate && npx prisma db push
+RUN pnpm install
+
+RUN pnpm prisma generate
 
 USER node
 
 # PRODUCTION
 
-FROM node:20-alpine As production
+FROM node:20 As production
 
 COPY --chown=node:node --from=build /usr/src/app/node_modules ./node_modules
+COPY --chown=node:node --from=build /usr/src/app/.docker ./.docker
+COPY --chown=node:node --from=build /usr/src/app/prisma ./prisma
 COPY --chown=node:node --from=build /usr/src/app/dist ./dist
 
-CMD [ "node", "dist/src/main.js" ]
+RUN chmod +x ./.docker/start.sh
+
+ENTRYPOINT ["/bin/sh", "./.docker/start.sh"]

README.md

@@ -3,51 +3,49 @@
 <h1 align="center">
   <br />
     <a href="#****" target="blank">
-      <img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo">
+      <img src="./.github/svg/Logo.svg" width="200">
     </a>
+
+  <br />
   <br />
 
-NestJs Boilerplate
+TMS <em>(Transportation Management System)</em>
 <br />
 
 </h1>
 
-<h4 align="center">A Better template with <a href="http://nestjs.com" target="_blank"><em>NestJs</em></a> with technologies to improve development.</h4>
-
 <p align="center">
-  <a href="https://codecov.io/gh/GabrielGuedess/NestJs-Boilerplate">
-    <img src="https://codecov.io/gh/GabrielGuedess/NetJs-Boilerplate/branch/master/graph/badge.svg?token=B7DKN82TEH">
+  <a href="https://codecov.io/gh/GabrielGuedess/TMS-Server">
+    <img src="https://codecov.io/gh/GabrielGuedess/TMS-Server/branch/master/graph/badge.svg?token=B7DKN82TEH">
   </a>
 
   <a href="#">
-    <img src="https://img.shields.io/github/license/GabrielGuedess/NestJs-Boilerplate">
+    <img src="https://img.shields.io/github/license/GabrielGuedess/TMS-Server">
   </a>
 
   <a href="#">
-    <img src="https://img.shields.io/github/actions/workflow/status/GabrielGuedess/NestJs-Boilerplate/ci.yml?label=CI">
+    <img src="https://img.shields.io/github/actions/workflow/status/GabrielGuedess/TMS-Server/ci.yml?label=CI">
   </a>
 
   <a href="#">
-    <img src="https://img.shields.io/github/languages/count/GabrielGuedess/NestJs-Boilerplate">
+    <img src="https://img.shields.io/github/languages/count/GabrielGuedess/TMS-Server">
   </a>
 
   <a href="#">
-    <img src="https://img.shields.io/github/languages/top/GabrielGuedess/NestJs-Boilerplate">
+    <img src="https://img.shields.io/github/languages/top/GabrielGuedess/TMS-Server">
   </a>
 
-  <a href="https://wakatime.com/badge/github/GabrielGuedess/NestJs-Boilerplate">
-    <img src="https://wakatime.com/badge/github/GabrielGuedess/NestJs-Boilerplate.svg" alt="Wakatime">
+  <a href="https://wakatime.com/badge/github/GabrielGuedess/TMS-Server">
+    <img src="https://wakatime.com/badge/github/GabrielGuedess/TMS-Server.svg" alt="Wakatime">
   </a>
 </p>
 
   <p align="center">
-    <a href="https://github.com/GabrielGuedess/NestJs-Boilerplate/issues">Report Bug</a>
+    <a href="https://github.com/GabrielGuedess/TMS-Server/issues">Report Bug</a>
     ·
-    <a href="https://github.com/GabrielGuedess/NestJs-Boilerplate/issues">Request Feature</a>
+    <a href="https://github.com/GabrielGuedess/TMS-Server/issues">Request Feature</a>
   </p>
 
-![image](https://github.com/GabrielGuedess/NestJs-Boilerplate/assets/64827875/1129f844-627b-4a66-a8c0-0835f1b25caa)
-
 <!-- TABLE OF CONTENTS -->
 
 <details>
@@ -81,12 +79,13 @@ NestJs Boilerplate
 The following tools were used in building the project:
 
 - ![NestJS](https://img.shields.io/badge/nestjs-%23E0234E.svg?style=for-the-badge&logo=nestjs&logoColor=white)
-- ![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
+- ![Fastify](https://img.shields.io/badge/fastify-%23000000.svg?style=for-the-badge&logo=fastify&logoColor=white)
 - ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
 - ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
 - ![Prisma](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white)
 - ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)
-- ![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)
+- ![Apollo-GraphQL](https://img.shields.io/badge/-ApolloGraphQL-311C87?style=for-the-badge&logo=apollo-graphql)
+- ![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?style=for-the-badge&logo=graphql&logoColor=white)
 - ![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
 - ![Codecov](https://img.shields.io/badge/Codecov-F01F7A?style=for-the-badge&logo=Codecov&logoColor=white)
 - ![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
@@ -123,13 +122,13 @@ To clone and run this application, you'll need _Git_ and _Docker_ installed on y
 ### Installation
 
 ```sh
-git clone https://github.com/GabrielGuedess/NestJs-Boilerplate
+git clone https://github.com/GabrielGuedess/TMS-Server
 ```
 
 2. Go into the repository
 
 ```sh
-cd NestJs-Boilerplate
+cd TMS-Server
 ```
 
 3. Run Docker.
@@ -154,7 +153,7 @@ docker-compose up -d
   - [ ] Add `POSTGRES_USER` to .env.
   - [ ] Add `POSTGRES_PASSWORD` to .env.
 
-See the [open issues](https://github.com/GabrielGuedess/NestJs-Boilerplate/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/GabrielGuedess/TMS-Server/issues) for a full list of proposed features (and known issues).
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -188,12 +187,12 @@ Distributed under the MIT License. See [MIT license](LICENSE) for more informati
 
 Gabriel Guedes - [@GabrielRGuedess](https://twitter.com/GabrielRGuedess) - gabrielrguedess@gmail.com
 
-Project Link: [https://github.com/GabrielGuedess/NestJs-Boilerplate](https://github.com/GabrielGuedess/NestJs-Boilerplate)
+Project Link: [https://github.com/GabrielGuedess/TMS-Server](https://github.com/GabrielGuedess/TMS-Server)
 
 ---
 
 <p align="center">
-Made with ♥ by 👨‍🚀 Gabriel Guedes 👋 <a href="https://www.linkedin.com/in/gabriel-guedess/">Get in touch!</a>
+Made with ♥ by 👨‍🚀 Gabriel Guedes and Gabriel de Souza 👋 <a href="https://www.linkedin.com/in/gabriel-guedess/">Get in touch!</a>
 </p>
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>

jest.config.ts

@@ -1,16 +1,23 @@
-import type { Config } from 'jest';
+/* eslint-disable @typescript-eslint/naming-convention */
+import { type Config } from 'jest';
 
 const config: Config = {
   verbose: true,
-  moduleFileExtensions: ['js', 'json', 'ts'],
   rootDir: './src',
+  testEnvironment: 'node',
   testRegex: '.*\\.spec\\.ts$',
+  coverageDirectory: '../coverage',
+  collectCoverageFrom: ['**/*.ts'],
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  setupFiles: ['<rootDir>../.jest/jest.setup.ts'],
+  moduleDirectories: ['node_modules', 'src'],
+  modulePaths: ['<rootDir>/src/', '<rootDir>/.jest'],
+  moduleNameMapper: {
+    '^@test(.*)$': '<rootDir>../test$1',
+  },
   transform: {
     '^.+\\.(t|j)s$': 'ts-jest',
   },
-  collectCoverageFrom: ['**/*.(t|j)s'],
-  coverageDirectory: '../coverage',
-  testEnvironment: 'node',
 };
 
 export default config;

nest-cli.json

@@ -1,5 +1,9 @@
 {
   "$schema": "https://json.schemastore.org/nest-cli",
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
+  "sourceRoot": "src",
+  "entryFile": "infra/main",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
 }