wpcas service

.dockerignore

@@ -0,0 +1,4 @@
+.vscode/
+node_modules/
+dist/
+npm-debug.log

.env.example

@@ -0,0 +1,20 @@
+NODE_ENV=development
+APP_NAME="WPCAS Survey API"
+API_PREFIX=api
+APP_PORT=
+
+DATABASE_USERNAME=
+DATABASE_PASSWORD=
+DATABASE_NAME=
+TELEMETRY_DATABASE_NAME=
+DATABASE_PORT=
+PASSBOOK_SERVICE_URL=
+SUNBIRD_SERVICE_URL=
+DATABASE_URL=postgresql://${DATABASE_USERNAME}:${DATABASE_PASSWORD}@172.17.0.1:${DATABASE_PORT}/${DATABASE_NAME}?schema=public
+USER_SERVICE_TOKEN=
+USER_SERVICE_COOKIE=
+USER_SERVICE_URL=
+FRAC_SERVICE_URL=
+##expression configured to trigger the CRON job EVERY_WEEKEND 
+FRAC_CRON_EPX="0 0 * * 6,0"
+USER_CRON_EPX="0 0 * * 6,0"

.gitignore

@@ -1,6 +1,7 @@
 # compiled output
 dist
 node_modules
+.data
 
 # enviornment variables
 .env

Dockerfile

@@ -1,6 +1,11 @@
+
+# Use the official Node.js 18 image as a base
 FROM node:18.16.1-alpine
 
+# Install bash for debugging purposes (optional)
 RUN apk add --no-cache bash
+
+# Install global Node.js packages for NestJS development
 RUN npm i -g @nestjs/cli typescript ts-node
 
 # Set the working directory inside the container
@@ -9,33 +14,23 @@ WORKDIR /usr/src/app
 # Copy package.json and package-lock.json to the working directory
 COPY package*.json ./
 
+# Copy the Prisma configuration and migration files
+# This line copies the "prisma" directory from your project's root into the Docker container's working directory.
+COPY prisma ./prisma/
+COPY env-example ./.env
 # Install project dependencies
 RUN npm install
 
 # Copy the rest of the application code to the container
 COPY . .
 
-# Expose the PORT environment variable (default to 4000 if not provided)
-ARG PORT=4010
-ENV PORT=$APP_PORT
-
-
-# COPY package*.json /tmp/app/
-# RUN cd /tmp/app && npm install
-
-# COPY . /usr/src/app
-# RUN cp -a /tmp/app/node_modules /usr/src/app
-# COPY ./wait-for-it.sh /opt/wait-for-it.sh
-# COPY ./startup.dev.sh /opt/startup.dev.sh
-# RUN sed -i 's/\r//g' /opt/wait-for-it.sh
-# RUN sed -i 's/\r//g' /opt/startup.dev.sh
-
-# RUN cp env-example .env
-
 # Build your Nest.js application
 RUN npm run build
 
+# Expose the PORT environment variable (default to 4000 if not provided)
+ARG PORT=4000
+ENV PORT=$PORT
+EXPOSE $PORT
+
 # Start the Nest.js application using the start:prod script
 CMD ["npm", "run", "start:prod"]
-
-# CMD ["/opt/startup.dev.sh"]

README.md

@@ -1 +1,50 @@
-# Microservice boilerplate 
+# WPCAS - Workplace Competency Assessment Score
+
+## About
+
+WPCAS is a vital component of COMPASS, a goal-oriented human resource management system (GO-HRM) designed to help organizations align their objectives with well-defined targets for teams and individuals. This system maps competencies required to achieve these targets and establishes a connection between capacity and performance management.
+
+WPCAS specifically focuses on Workplace Competency Assessment Scores, offering a comprehensive 360-degree feedback survey for employees. This survey involves input from juniors, seniors, and colleagues, providing valuable insights into an employee's strengths and weaknesses based on workplace performance.
+
+## Tech Stack
+
+- **Language:** TypeScript
+- **Database:** PostgreSQL
+- **ORM:** Prisma
+- **Framework:** NestJS
+- **Node Version:** 18.16.1-alpine
+
+## Setup
+
+1. Install the necessary package dependencies:
+    ```bash
+    npm i
+    ```
+
+2. Set up PostgreSQL in your local environment.
+
+3. Configure environment variables:
+    - Create an environment variable file (e.g., `.env`) using the example file as a reference.
+
+4. Generate Prisma migrations:
+    ```bash
+    npx prisma migrate dev
+    ```
+    - If seed data is required, populate it by running:
+        ```bash
+        npx prisma db seed
+        ```
+        or for a complete reset (including deleting all previous data):
+        ```bash
+        npx prisma migrate reset
+        ```
+
+5. Running a Local Development Server:
+    ```bash
+    npm run start:dev
+    ```
+    - Access the Swagger API documentation at `http://YOUR_APP_PORT/api/docs`
+
+## License
+
+This project is licensed under the [LICENSE NAME] - see the [LICENSE.md](LICENSE.md) file for details.

docker-compose.yaml

@@ -1,38 +1,27 @@
-services:
-  postgres:
-    image: postgres:15.3-alpine
-    ports:
-      - ${DATABASE_PORT}:5432
-    volumes:
-      - ./.data/db:/var/lib/postgresql/data
-    environment:
-      POSTGRES_USER: ${DATABASE_USERNAME}
-      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
-      POSTGRES_DB: ${DATABASE_NAME}
-
-  # maildev:
-  #   build:
-  #     context: .
-  #     dockerfile: maildev.Dockerfile
-  #   ports:
-  #     - ${MAIL_CLIENT_PORT}:1080
-  #     - ${MAIL_PORT}:1025
-
-  # adminer:
-  #   image: adminer
-  #   restart: always
-  #   ports:
-  #     - 8080:8080
-
-  # Uncomment to use redis
-  # redis:
-  #   image: redis:7-alpine
-  #   ports:
-  #     - 6379:6379
+version: '3'
 
+services:
   api:
     build:
       context: .
       dockerfile: Dockerfile
     ports:
       - ${APP_PORT}:${APP_PORT}
+    networks:
+      - samagra_compass
+
+networks:
+  samagra_compass:
+    external: true
+
+#  postgres:
+#    image: postgres:15.3-alpine
+#    ports:
+#      - ${DATABASE_PORT}:5432
+#    volumes:
+#      - ./.data/db:/var/lib/postgresql/data
+#    environment:
+#      POSTGRES_USER: ${DATABASE_USERNAME}
+#      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
+#      POSTGRES_DB: ${DATABASE_NAME}
+

e2e.Dockerfile

@@ -20,9 +20,13 @@
 # CMD ["/opt/startup.ci.sh"]
 
 
+# Use the official Node.js 18 image as a base
 FROM node:18.16.1-alpine
 
+# Install bash for debugging purposes (optional)
 RUN apk add --no-cache bash
+
+# Install global Node.js packages for NestJS development
 RUN npm i -g @nestjs/cli typescript ts-node
 
 # Set the working directory inside the container
@@ -31,18 +35,23 @@ WORKDIR /usr/src/app
 # Copy package.json and package-lock.json to the working directory
 COPY package*.json ./
 
+# Copy the Prisma configuration and migration files
+# This line copies the "prisma" directory from your project's root into the Docker container's working directory.
+COPY prisma ./prisma/
+
 # Install project dependencies
 RUN npm install
 
 # Copy the rest of the application code to the container
 COPY . .
 
-# Expose the PORT environment variable (default to 4000 if not provided)
-ARG PORT=4010
-ENV PORT=$APP_PORT
-
 # Build your Nest.js application
 RUN npm run build
 
+# Expose the PORT environment variable (default to 4000 if not provided)
+ARG PORT=4000
+ENV PORT=$PORT
+EXPOSE $PORT
+
 # Start the Nest.js application using the start:prod script
 CMD ["npm", "run", "start:prod"]