🥳 complete template

.gitignore

@@ -5,10 +5,12 @@ dist
 #migration
 prisma/migrations
 #env
-.env
+#.env
 #swagger docs
 public
 #vscode
 .vscode
 #db persistance
-pg_db
+pg_db
+#coverage test
+coverage

CHANGELOG

@@ -0,0 +1,3 @@
+1.0.0 -
+
+- Create node-express-ts template/skeleton/boilerplate

Dockerfile

@@ -0,0 +1,26 @@
+# syntax=docker/dockerfile:1
+
+ARG NODE_VERSION=18.13
+
+FROM node:${NODE_VERSION}-alpine as base
+WORKDIR /usr/src/app
+EXPOSE 3000
+
+FROM base as dev
+#RUN --mount=type=bind,source=package.json,target=package.json \
+#    --mount=type=bind,source=package-lock.json,target=package-lock.json \
+#    --mount=type=cache,target=/root/.npm \
+#    npm ci --include=dev
+COPY package.json package-lock.json ./
+RUN npm install
+COPY . .
+CMD npm run dev
+
+FROM base as prod
+RUN --mount=type=bind,source=package.json,target=package.json \
+    --mount=type=bind,source=package-lock.json,target=package-lock.json \
+    --mount=type=cache,target=/root/.npm \
+    npm ci --omit=dev
+USER node
+COPY . .
+CMD node src/app.js

README.md

@@ -1 +1,73 @@
-# node-express-template
+# 🩻 Node-Express Template
+
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/mayel15/node-express-template)
+
+👨🏾‍💻 Pape THIAM [@mayel15](https://github.com/mayel15)
+
+# 🧰 Stack
+
+<a href="https://nodejs.org/docs/latest/api/" target="_blank" rel="noreferrer"> <img src="https://img.icons8.com/?size=100&id=hsPbhkOH4FMe&format=png&color=000000" alt="nodejs" width="100" height="100"/> </a> <a href="https://expressjs.com/" target="_blank" rel="noreferrer"> <img src="https://img.icons8.com/?size=100&id=kg46nzoJrmTR&format=png&color=000000" alt="express" width="100" height="100"/> </a> <a href="https://jestjs.io/fr/docs/getting-started" target="_blank" rel="noreferrer"> <img src="https://img.icons8.com/?size=100&id=bp24DwGXJDyT&format=png&color=000000" alt="jest" width="100" height="100"/> </a> <a href="https://www.prisma.io/docs" target="_blank" rel="noreferrer"> <img src="https://img.icons8.com/?size=100&id=aqb9SdV9P8oC&format=png&color=000000" alt="prisma" width="100" height="100"/> </a> <a href="https://www.typescriptlang.org/docs/" target="_blank" rel="noreferrer"> <img src="https://img.icons8.com/?size=100&id=wpZmKzk11AzJ&format=png&color=000000" alt="typescript" width="100" height="100"/> </a> <a href="https://www.postgresql.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/postgresql/postgresql-original-wordmark.svg" alt="postgresql" width="100" height="100"/> </a></a> <a href="https://www.docker.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/docker/docker-original-wordmark.svg" alt="docker" width="100" height="100"/> </a>
+
+## ➕ More
+
+- Supertest
+- Swagger
+
+# 📄 Description du projet
+
+This is an opinionated boilerplate (template or skeleton, whatever you want) for Express and TypeScript. It uses Prisma as an ORM to easily switch databases with minimal code changes. This repository serves as a template to simplify the [creation of new repositories from it](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
+
+## ⨠ Architecture
+
+![alt text](readme-images/archi-server-template.png)
+
+## 🗂️ `src` folder
+
+```sh
+├── controllers
+├── enums
+├── middlewares
+├── models
+├── repositories
+├── routes
+├── services
+└── utils
+```
+
+# 🤖 Run and commands
+
+- ⎒ Clone the project or create a repo git from this template
+
+```sh
+git clone https://github.com/mayel15/node-express-template
+```
+
+- 🚀 Run the server app with `Docker`
+
+```sh
+cd node-express-template
+```
+
+```sh
+docker-compose up -d
+```
+
+- 🕙 Wait a moment
+
+- ⚙️ The server will normally run at `http://localhost:3000/` and the route `/docs` is for `swagger`
+
+- 🎞️ Overview of the runninng server
+
+  - With `Docker Desktop`
+
+    ![alt text](readme-images/overview-server-running-docker.png)
+
+  - With the `browser`
+
+    ![alt text](readme-images/overview-server-running-browser.png)
+
+- 🧪 Run test
+
+```sh
+npm run test
+```

docker-compose.yml

@@ -16,6 +16,28 @@ services:
       - 5435:5432/tcp
     volumes:
       - "./pg_db:/var/lib/postgresql/data"
+    healthcheck:
+      test: [ "CMD", "pg_isready" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  server:
+    build:
+      context: .
+      target: dev
+    ports:
+      - 3000:3000
+      - 9229:9229
+    environment:
+      NODE_ENV: production
+      POSTGRES_HOST: pgdb
+      POSTGRES_PORT: 5432
+    depends_on:
+      pgdb:
+        condition: service_healthy
+    volumes:
+      - ./:/usr/src/app
 
 
 

env/.env

@@ -0,0 +1,13 @@
+NODE_ENV=template
+PORT=3000
+API_URL=http://localhost:3000
+
+
+# This was inserted by `prisma init`:
+# Environment variables declared in this file are automatically made available to Prisma.
+# See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema
+
+# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
+# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
+
+DATABASE_URL="postgresql://postgres:postgres@localhost:5435/node-express-template"

env/.env.dev

@@ -9,4 +9,4 @@ API_URL=http://localhost:3000
 # Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
 # See the documentation for all the connection string options: https://pris.ly/d/connection-strings
 
-DATABASE_URL="postgresql://postgres:postgres@localhost:5435/senwata"
+DATABASE_URL="postgresql://postgres:postgres@localhost:5435/node-express-template"

env/.env.prod

@@ -9,4 +9,4 @@ API_URL=http://localhost:3000
 # Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
 # See the documentation for all the connection string options: https://pris.ly/d/connection-strings
 
-DATABASE_URL="postgresql://postgres:postgres@localhost:5435/senwata"
+DATABASE_URL="postgresql://postgres:postgres@localhost:5435/node-express-template"

jest.config.ts

@@ -0,0 +1,202 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from "jest";
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/rd/b_1lc5011lb5n40rp_xx_s2c0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+  transform: {
+    "\\.(ts)$": "ts-jest",
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;