Feature - Discussions connected to DB (#21)

* chore: NodeJS template added with middlewares: JOI and Boom. Jest added.

* docs: added discussion endpoint documentation to readme.md (#4)

* feat: discussion CRUD without SQL connection

feat: CRUD without SQL connection

docs: discussion endpoints updated

* feat: cors for accepting all CORS request (#11)

Added Cors for accepting all requests

* Feature - Discussion_Like capabilities (#8)

feat: CRUD without SQL connection for discussion_likes

docs: discussion endpoints updated

docs: like endpoints updated

docs: readme.md modified with endpoint description for use

* chore: Procfile added for Heroku deployment, port from environment added (#13)

* chore: added dummy data for discussion testing (#17)

* chore: dotenv capabilities added, .env.example file added (#20)

chore: added localhost postgres environment

chore: added db config

docs: discussion endpoint doc modified

feat: discussions db connection without pagination

chore: migrations and seeders added for deployment

docs: discussion instrictions added for local env

Author: dmorav1

.env.example

@@ -0,0 +1,19 @@
+#Docker Postgres Variables
+POSTGRES_DB=communitydb
+POSTGRES_USER=dev_admin
+POSTGRES_PASSWORD=devAdmin123
+
+#PGAdmin docker image
+PGADMIN_DEFAULT_EMAIL=admin@mail.com
+PGADMIN_DEFAULT_PASSWORD=root
+
+#Server config
+PORT=3002
+
+#Database connection configuration (If you are using docker postgress image, use the same configuration)
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=dev_admin
+DB_PASSWORD=devAdmin123
+DB_NAME=communitydb
+DB_SCHEMA= 'sch_comm'

.gitignore

@@ -191,4 +191,7 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
+# Postgres data files
+data
+
 # End of https://www.toptal.com/developers/gitignore/api/node,windows,linux,macos

.sequelizerc

@@ -0,0 +1,6 @@
+module.exports = {
+  'config': './src/db/config.js',
+  'models-path': './src/db/models/',
+  'migrations-path': './src/db/migrations/',
+  'seeders-path': './src/db/seeders/',
+}

README.md

@@ -2,7 +2,21 @@
 This backend API is used as an interface for Forum interaction with backend. 
 
 ## Steps to run & deploy
-### Load and Connect Database
+
+### Initial setup
+For local environment setup for first time, please copy information from file .env.example to .env and run following command: 
+
+   docker-compose up -d
+
+that will setup postgres and PGAdmin 4 for initial setup.
+
+After that, run all migrations: 
+
+    migrations:run
+
+After migrations are completed as an aditional step you can copy information inside ./tests/dummy-data.json and create a file under ./src/data/ with the name seed_data.json. It contains the information for demo/testing purposes. 
+
+
 
 ### Running in dev
 For running your server in dev environment please use the following command: 
@@ -41,21 +55,26 @@ You can get a list of all invoices using endpoint `/api/discussions/{id}` by a G
 	"title": "Example Title",
 	"content": "Example Content",
 	"category": 1,
-	"created_at": "2012-04-23T18:25:43.511Z",
-	"created_by": 1,
-	"modified_at": null,
-	"modified_by": null,
+
+	"createdAt": "2012-04-23T18:25:43.511Z",
+	"userId": 1,
+	"modifiedAt": null,
+	"modifiedBy": null,
 	"status": 1,
-	"discussion_version_no": 1
+	"discussionVersionNo": 1
 }
 ```
 ### Create a new discussion
-You can create a new discussion using endpoint `/api/discussions/create` by a POST HTTP request with following body: 
+You can create a new discussion using endpoint `/api/discussions` by a POST HTTP request with following body: 
+
 ```json
 {  
 	"title": "Example Title",
 	"content": "Example Content",
-	"category": 1,
+
+	"categoryId": 1,
+    "userId": 1
+
 }
 ```
 This will return the created discussion with void comments as: 
@@ -65,12 +84,14 @@ This will return the created discussion with void comments as:
 	"title": "Example Title",
 	"content": "Example Content",
 	"category": 1,
-	"created_at": "2012-04-23T18:25:43.511Z",
-	"created_by": 1,
-	"modified_at": null,
-	"modified_by": null,
+
+	"createdAt": "2012-04-23T18:25:43.511Z",
+	"userId": 1,
+	"modifiedAt": null,
+	"modifiedBy": null,
 	"status": 1,
-	"discussion_version_no": 1
+	"discussionVersionNo": 1
+
 }
 ```
 ### Get all discussion likes
@@ -114,7 +135,8 @@ You can give like to an existing discussion using endpoint `/api/likes/discussio
 ```json
 {  
 	"discussionId": 1,
-	"user_id": 2
+	"userId": 2
+
 }	
 ```
 This will return the created like as: 

app/app.js

@@ -0,0 +1,21 @@
+version: ‘3.3’
+
+services:
+  postgres:
+    image: postgres:13
+    env_file:
+      .env
+    ports:
+      - 5432:5432
+    volumes:
+    - ./data/postgres:/var/lib/postgresql/data
+    - ./sql/1_init.sql:/docker-entrypoint-initdb.d/1_init.sql
+    restart: always
+    networks:
+        - default
+  pgadmin:
+    image: dpage/pgadmin4
+    env_file:
+      .env
+    ports:
+      - 5050:80