initializing the project -> add build configurations

Author: ishubham21

.babelrc

@@ -0,0 +1,13 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        }
+      }
+    ],
+    "@babel/preset-typescript"
+  ]
+}

.dockerignore

@@ -0,0 +1,2 @@
+/node_modules
+npm-debug.log

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+max_line_length = 70
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,ts}]
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,4 @@
+/node_modules
+/tests
+/dist
+jest.config.js

.eslintrc

@@ -0,0 +1,26 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "plugins": ["@typescript-eslint", "no-loops", "import"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-useless-escape": "off",
+    "no-undef": "off",
+    "no-console": "warn",
+    "no-alert": "error",
+    "camelcase": "error",
+    "no-loops/no-loops": "error",
+    "@typescript-eslint/no-inferrable-types": "off"
+  },
+  "env": {
+    "node": true,
+    "es6": true
+  }
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+# Keep environment variables out of version control
+.env

.prettierignore

@@ -0,0 +1,4 @@
+/public
+/coverage
+/dist
+jest.confi.js

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "all",
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "printWidth": 70
+}

Dockerfile

@@ -0,0 +1,40 @@
+FROM node:16-alpine AS base
+
+# Not intended to be verbose
+ARG NPM_LOG_LEVEL=silent
+# Hide Open Collective message from install logs
+ENV OPENCOLLECTIVE_HIDE=1
+# Hide NPM security message from install logs
+ENV NPM_CONFIG_AUDIT=false
+# Hide NPM funding message from install logs
+ENV NPM_CONFIG_FUND=false
+
+# Update npm to version 7
+RUN npm i -g [email protected]
+
+# Set the working directory
+WORKDIR /app/server
+
+# Copy files specifying dependencies
+COPY package.json package-lock.json ./
+
+# Install dependencies
+RUN npm ci --loglevel=$NPM_LOG_LEVEL;
+
+# Copy Prisma schema
+COPY prisma/schema.prisma ./prisma/
+
+# Generate Prisma client
+RUN npm run prisma:generate;
+
+# Copy all the files
+COPY . .
+
+# Build code - genearets a dist folder from the contents of the src folder
+RUN npm run build
+
+# Expose the port the server listens to
+EXPOSE 4000
+
+# Run server
+CMD [ "node", "dist/index.js"]

README.md

@@ -0,0 +1,15 @@
+version: "3"
+services:
+  db:
+    image: postgres:12
+    ports:
+      - "${POSTGRESQL_PORT}:5432"
+    environment:
+      POSTGRES_USER: ${POSTGRESQL_USER}
+      POSTGRES_PASSWORD: ${POSTGRESQL_PASSWORD}
+    volumes:
+      - postgres:/var/lib/postgresql/data
+
+#for data to persist
+volumes:
+  postgres: ~

dist/index.js

@@ -0,0 +1,62 @@
+# I will use this file only in the proudction for deployment
+# I might not use it whatsoever if I don't find a good place to host it lol
+
+# To summaize: Create a DB (postgres image) service -> Create Migrations on the Database (if any, but yet an important step just in case the migration has changed or something) -> Pick the configurations from Dockerfile and run the server on the specified port
+
+version: "3"
+services:
+  server:
+    build:
+      #make use of Dockerfile
+      context: .
+      args:
+        NPM_LOG_LEVEL: notice
+    ports:
+      - "${PORT}:4000"
+    environment:
+      DATABASE_URL: "${DATABASE_URL}"
+    depends_on:
+      - migration
+
+  migration:
+    build:
+      context: .
+      args:
+        NPM_LOG_LEVEL: notice
+    command: npm run db:init
+    working_dir: /app/server
+    environment:
+      DATABASE_URL: "${DATABASE_URL}"
+    depends_on:
+      db:
+        condition: service_healthy
+
+  #Same service as docker-compose.db.yaml - docker-compose.db.yml is for someone who doesn't want to use this docker-compose.yaml for building
+  db:
+    image: postgres:12
+    environment:
+      POSTGRES_USER: ${POSTGRESQL_USER}
+      POSTGRES_PASSWORD: ${POSTGRESQL_PASSWORD}
+      ports: ${POSTGRESQL_PORT}:5432
+    volumes:
+      - postgres:/var/lib/postgresql/data
+    healthcheck:
+      test:
+        [
+          "CMD",
+          "pg_isready",
+          "-q",
+          "-d",
+          "${POSTGRESQL_DB_NAME}",
+          "-U",
+          "${POSTGRESQL_USER}",
+        ]
+      timeout: 45s
+      interval: 10s
+      retries: 10
+    
+    #should add a redis image too
+
+#for data to persist
+volumes:
+  postgres: ~

docker-compose.db.yml

@@ -0,0 +1,5 @@
+module.exports = {
+  testEnvironment: "node", //deafult is jsdom i.e test envrionment
+  testRegex: "/.*\\.(test|spec)?\\.(ts)$", //under test folder, file names should be tests/newTest.test(spec).ts
+  moduleFileExtensions: ["ts", "js", "json", "node"],
+};

docker-compose.yml

@@ -0,0 +1,15 @@
+::1 - - [08/Sep/2022:04:47:02 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:03:38 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:03:40 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:03:50 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:03:59 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:04:00 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:04:01 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:04:02 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:36 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:37 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:37 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:37 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:38 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:41 +0000] "GET / HTTP/1.1" 304 -
+::1 - - [08/Sep/2022:05:06:42 +0000] "GET / HTTP/1.1" 304 -