REST service: Logging, Error Handling and Authentication and Authorization

.dockerignore

@@ -0,0 +1,6 @@
+node_modules
+npm-debug.log
+Dockerfile*
+docker-compose.yml
+.git
+.gitignore

.env

@@ -0,0 +1,18 @@
+PORT=4000
+
+CRYPT_SALT=10
+JWT_ACCESS_SECRET=123123
+JWT_REFRESH_SECRET=123123
+LOG_LEVEL=debug
+TOKEN_EXPIRE_TIME=1h
+TOKEN_REFRESH_EXPIRE_TIME=24h
+
+DB_HOST=localhost
+DB_PORT=5432
+DB_USERNAME=user123
+DB_PASSWORD=111222
+DB_NAME=appdb
+
+POSTGRES_USER=user123
+POSTGRES_PASSWORD=111222
+POSTGRES_DB=appdb

.env.example

@@ -1,7 +1,13 @@
 PORT=4000
 
 CRYPT_SALT=10
-JWT_SECRET_KEY=secret123123
-JWT_SECRET_REFRESH_KEY=secret123123
+JWT_SECRET_KEY=123123
+JWT_SECRET_REFRESH_KEY=123123
 TOKEN_EXPIRE_TIME=1h
 TOKEN_REFRESH_EXPIRE_TIME=24h
+
+DB_HOST=localhost
+DB_PORT=5432
+DB_USERNAME=user123
+DB_PASSWORD=111222
+DB_NAME=musicdb

Dockerfile

@@ -0,0 +1,29 @@
+#stage1
+FROM node:20-alpine AS builder
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+RUN npm run build
+
+#stage2
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install --production
+
+COPY --from=builder /app/dist ./dist
+COPY --from=builder /app/.env ./
+
+
+EXPOSE 3000
+
+CMD ["node", "dist/main.js"]

README.md

@@ -5,27 +5,32 @@
 - Git - [Download & Install Git](https://git-scm.com/downloads).
 - Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
 
-## Downloading
+## INSTALATION 
+
+### 1. Downloading
 
 ```
-git clone {repository URL}
+git clone https://github.com/YuliaDemir/nodejs2025Q2-service.git
+cd nodejs2025Q2-service
 ```
 
-## Installing NPM modules
+### 2. Moving to the development branch
 
 ```
-npm install
+git checkout dev2
 ```
 
-## Running application
+## RUNNING application
+
+### 1. Launch your docker app
+
+### 2. Assemble and launch the containers
 
 ```
-npm start
+docker-compose up --build
 ```
 
 After starting the app on port (4000 as default) you can open
-in your browser OpenAPI documentation by typing http://localhost:4000/doc/.
-For more information about OpenAPI/Swagger please visit https://swagger.io/.
 
 ## Testing
 

doc/api.yaml

@@ -5,7 +5,7 @@ info:
   version: 1.0.0
 
 servers:
-  - url: /api
+  - url: /4000
 
 components:
   schemas:
@@ -117,79 +117,7 @@ security:
   - bearerAuth: []
 
 paths:
-  /login:
-    post:
-      tags:
-        - Login
-      security: []
-      summary: Login
-      description: Logins a user and returns a JWT-token
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              title: example
-              properties:
-                login:
-                  type: string
-                  description: Username
-                password:
-                  type: string
-                  description: Password
-              required:
-                - user
-                - login
-      responses:
-        200:
-          description: Successful login.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  token:
-                    type: string
-                description: JWT Token
-        403:
-          description: Incorrect login or password
-  /signup:
-    post:
-      tags:
-        - Signup
-      security: [ ]
-      summary: Signup
-      description: Signup a user
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              title: example
-              properties:
-                login:
-                  type: string
-                  minLength: 3
-                  maxLength: 255
-                  description: Username
-                password:
-                  type: string
-                  format: password
-                  pattern: ^[a-zA-Z0-9]{3,30}
-                  description: Password
-              required:
-                - login
-                - password
-      responses:
-        204:
-          description: Successful signup
-        400:
-          description: Bad request
-        409:
-          description: Conflict. Login already exists
-  /users:
+  /user:
     get:
       tags:
         - Users
@@ -239,7 +167,7 @@ paths:
           description: Bad request. body does not contain required fields
         401:
           $ref: '#/components/responses/UnauthorizedError'
-  /users/{userId}:
+  /user/{userId}:
     parameters:
       - name: userId
         in: path
@@ -334,7 +262,7 @@ paths:
           $ref: '#/components/responses/UnauthorizedError'
         404:
           description: User not found
-  /tracks:
+  /track:
     get:
       tags:
         - Track
@@ -388,7 +316,7 @@ paths:
           description: Bad request. body does not contain required fields
         401:
           $ref: '#/components/responses/UnauthorizedError'
-  /tracks/{id}:
+  /track/{id}:
     parameters:
       - name: id
         in: path
@@ -492,7 +420,7 @@ paths:
           $ref: '#/components/responses/UnauthorizedError'
         404:
           description: Track was not found.
-  /albums:
+  /album:
     get:
       tags:
         - Album
@@ -544,7 +472,7 @@ paths:
           description: Bad request. body does not contain required fields
         401:
           $ref: '#/components/responses/UnauthorizedError'
-  /albums/{id}:
+  /album/{id}:
     parameters:
       - name: id
         in: path
@@ -621,7 +549,7 @@ paths:
           $ref: '#/components/responses/UnauthorizedError'
         404:
           description: Album was not found.
-  /artists:
+  /artist:
     get:
       tags:
         - Artist
@@ -668,7 +596,7 @@ paths:
           description: Bad request. body does not contain required fields
         401:
           $ref: '#/components/responses/UnauthorizedError'
-  /artists/{id}:
+  /artist/{id}:
     parameters:
       - name: id
         in: path

docker-compose.yml

@@ -0,0 +1,40 @@
+version: '3.9'
+
+networks:
+  app-network:
+    driver: bridge
+
+services:
+  db:
+    build: ./postgres
+    container_name: postgres-db
+    environment: 
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_DB: ${POSTGRES_DB}
+    ports:
+      - "${DB_PORT}:${DB_PORT}"
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    networks:
+      - app-network
+
+  app:
+    build: .
+    restart: always
+    volumes:
+      - ./src:/app/src
+      - /app/node_modules
+    container_name: node-app
+    environment: 
+      DB_HOST: db
+      DB_USERNAME: ${DB_USERNAME}
+      DB_PASSWORD: ${DB_PASSWORD}
+      DB_NAME: ${DB_NAME}
+      PORT: ${PORT}
+    ports:
+      - "${PORT}:${PORT}"
+    networks:
+      - app-network
+volumes:
+  pgdata: