added env file example

Author: LCcodder

.dockerignore

@@ -1 +1,3 @@
-/node_modules
+/node_modules
+.DS_store
+app-schema.png

CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+PORT=8000
+DATABASE_HOST=localhost
+DATABASE_NAME=NodeNotes
+DATABASE_USER=postgres
+DATABASE_PASSWORD=postgres
+DATABASE_PORT=5432
+REDIS_CONNECTION_STRING=redis://127.0.0.1:6379/0

example.env

@@ -1,10 +1,10 @@
-import { createClient, RedisClientType } from 'redis';
-
-export const connectAndGetRedisInstance = async (connectionString?: string): Promise<RedisClientType> => {
-    const client = await createClient({ url: connectionString })
-        .on('error', err => console.log('[FATAL] Redis Client Error', err))
-        .on('connect', () => console.log(`[INFO] Connected to redis at ${connectionString}\n`))
-        .connect();
-
-    return client as RedisClientType
+import { createClient, RedisClientType } from 'redis';
+
+export const connectAndGetRedisInstance = async (connectionString?: string): Promise<RedisClientType> => {
+    const client = await createClient({ url: connectionString })
+        .on('error', err => console.log('[FATAL] Redis Client Error', err))
+        .on('connect', () => console.log(`[INFO] Connected to redis at ${connectionString}\n`))
+        .connect();
+
+    return client as RedisClientType
 }

source/api/v1/cache/InitRedisInstance.ts

@@ -1,35 +1,35 @@
-export const BaseUserSchema = {
-    type: 'object',
-    properties: {
-        login: {
-            type: 'string',
-            minLength: 4,
-            maxLength: 16
-        },
-        email: {
-            type: 'string',
-            minLength: 8,
-            maxLength: 60
-        },
-        password: {
-            type: 'string',
-            minLength: 8,
-            maxLength: 32
-        },
-        username: {
-            type: 'string',
-            minLength: 4,
-            maxLength: 32
-        },
-        personalColor: {
-            type: 'string',
-            minLength: 6,
-            maxLength: 13
-        },
-        isCollaborating: {
-            type: 'boolean'
-        },
-        createdAt: { type: 'string' },
-        updatedAt: { type: 'string' }
-    },
+export const BaseUserSchema = {
+    type: 'object',
+    properties: {
+        login: {
+            type: 'string',
+            minLength: 4,
+            maxLength: 16
+        },
+        email: {
+            type: 'string',
+            minLength: 8,
+            maxLength: 60
+        },
+        password: {
+            type: 'string',
+            minLength: 8,
+            maxLength: 32
+        },
+        username: {
+            type: 'string',
+            minLength: 4,
+            maxLength: 32
+        },
+        personalColor: {
+            type: 'string',
+            minLength: 6,
+            maxLength: 13
+        },
+        isCollaborating: {
+            type: 'boolean'
+        },
+        createdAt: { type: 'string' },
+        updatedAt: { type: 'string' }
+    },
 } as const

source/api/v1/validation/schemas/base/User.ts

@@ -1,42 +1,42 @@
-import { FastifyInstance } from "fastify"
-const swagger = require('@fastify/swagger')
-const swaggerUI = require('@fastify/swagger-ui')
-
-export const initSwaggerViewer = async (server: FastifyInstance): Promise<void> => {
-    await server.register(swagger, {
-        openapi: {
-            openapi: '3.0.0',
-            info: {
-                title: 'NodeNotes (api - v1)',
-                description: 'NodeNotes backend REST API endpoints specification',
-                version: '1.0.0'
-            },
-            servers: [
-                {
-                    url: 'http://localhost:8080',
-                    description: 'Development server'
-                }
-            ],
-            tags: [
-                { name: 'users', description: 'User related end-points (may require JWT in "Bearer" auth header)' },
-                { name: 'auth', description: 'Authorization end-points (may require JWT in "Bearer" auth header)' },
-                { name: 'notes', description: 'Note related end-points (requires JWT in "Bearer" auth header)' }
-            ],
-            externalDocs: {
-                url: 'https://github.com/LCcodder/NodeNotes',
-                description: 'GitHub repo'
-            }
-        }
-    })
-    
-    await server.register(swaggerUI, {
-        routePrefix: '/documentation',
-        uiConfig: {
-            deepLinking: false
-        },
-        staticCSP: true,
-        transformStaticCSP: (header: any) => header,
-        transformSpecification: (swaggerObject: any, _request: any, _reply: any) => { return swaggerObject },
-        transformSpecificationClone: true
-    })
+import { FastifyInstance } from "fastify"
+const swagger = require('@fastify/swagger')
+const swaggerUI = require('@fastify/swagger-ui')
+
+export const initSwaggerViewer = async (server: FastifyInstance): Promise<void> => {
+    await server.register(swagger, {
+        openapi: {
+            openapi: '3.0.0',
+            info: {
+                title: 'NodeNotes (api - v1)',
+                description: 'NodeNotes backend REST API endpoints specification',
+                version: '1.0.0'
+            },
+            servers: [
+                {
+                    url: 'http://localhost:8080',
+                    description: 'Development server'
+                }
+            ],
+            tags: [
+                { name: 'users', description: 'User related end-points (may require JWT in "Bearer" auth header)' },
+                { name: 'auth', description: 'Authorization end-points (may require JWT in "Bearer" auth header)' },
+                { name: 'notes', description: 'Note related end-points (requires JWT in "Bearer" auth header)' }
+            ],
+            externalDocs: {
+                url: 'https://github.com/LCcodder/NodeNotes',
+                description: 'GitHub repo'
+            }
+        }
+    })
+    
+    await server.register(swaggerUI, {
+        routePrefix: '/documentation',
+        uiConfig: {
+            deepLinking: false
+        },
+        staticCSP: true,
+        transformStaticCSP: (header: any) => header,
+        transformSpecification: (swaggerObject: any, _request: any, _reply: any) => { return swaggerObject },
+        transformSpecificationClone: true
+    })
 }