notification service documentation

src/api-doc/notification-service.md

@@ -0,0 +1,191 @@
+# ShikshaLokam Elevate Project Documentation
+
+## Notifications Service
+
+### System Requirements
+
+-   **Operating System:** Ubuntu 22
+-   **Node.js:** v20
+-   **PostgreSQL:** 16
+-   **Citus:** 12.1
+
+## Install Node.js
+
+Refer to the [NodeSource distributions installation scripts](https://github.com/nodesource/distributions#installation-scripts) for Node.js installation.
+
+```bash
+$ curl -SLO https://deb.nodesource.com/nsolid_setup_deb.sh
+$ sudo chmod 500 nsolid_setup_deb.sh
+$ sudo ./nsolid_setup_deb.sh 20
+$ sudo apt-get install nodejs -y
+```
+
+## Install Build Essential
+
+```bash
+$ sudo apt-get install build-essential
+```
+
+## Install PM2
+
+Refer to [How To Set Up a Node.js Application for Production on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-22-04).
+
+**Exit the postgres user account**
+
+```bash
+$ exit
+```
+
+```bash
+$ sudo npm install pm2@latest -g
+```
+
+## Setting up Repository
+
+### Clone the notification repository
+
+```bash
+$ cd /opt/
+$ sudo mkdir backend
+$ cd backend/
+$ git clone -b develop-2.5 --single-branch "https://github.com/ELEVATE-Project/notification.git"
+```
+
+### Install Npm packages
+
+```bash
+$ cd /opt/backend/notification/src
+$ sudo npm i
+```
+
+### Create .env files
+
+#### Notification Service
+
+```bash
+$ sudo nano .env
+```
+
+Copy-paste the following env variables to the `.env` file:
+
+```env
+# Notification Service Config
+
+# Port on which service runs
+APPLICATION_PORT=3002
+
+# Application environment
+APPLICATION_ENV=development
+
+# Route after the base URL
+APPLICATION_BASE_URL=/notification/
+
+# Kafka endpoint
+KAFKA_HOST="localhost:9092"
+
+# Kafka topic name
+KAFKA_TOPIC="dev.notification"
+
+# Kafka consumer group id
+KAFKA_GROUP_ID="elevate-notification"
+
+# Sendgrid API key
+SENDGRID_API_KEY="SG.asd9f87a9s8d7f."
+
+# Sendgrid sender email address
+SENDGRID_FROM_MAIL="no-reply@some.org"
+
+# Api doc URL
+API_DOC_URL= "/notification/api-doc"
+
+INTERNAL_ACCESS_TOKEN="internal_access_token"
+ERROR_LOG_LEVEL='silly'
+DISABLE_LOG=false
+DEV_DATABASE_URL=postgres://shikshalokam:slpassword@localhost:9700/elevate_notification
+
+ZEST_ENV= "ZEST_ENV"
+created_time= "2023-12-29T17:04:19.017783534Z"
+custom_metadata= null
+destroyed=false
+version=8
+```
+
+Save and exit.
+
+## Setting up Databases
+
+**Log into the postgres user**
+
+```bash
+sudo su postgres
+```
+
+**Log into psql**
+
+```bash
+psql -p 9700
+```
+
+**Create a database user/role:**
+
+```sql
+CREATE USER shikshalokam WITH ENCRYPTED PASSWORD 'slpassword';
+```
+
+**Create the elevate_notification database**
+
+```sql
+CREATE DATABASE elevate_notification;
+GRANT ALL PRIVILEGES ON DATABASE elevate_notification TO shikshalokam;
+\c elevate_notification
+GRANT ALL ON SCHEMA public TO shikshalokam;
+```
+
+## Running Migrations To Create Tables
+
+**Exit the postgres user account**
+
+```bash
+exit (run twice)
+```
+
+**Install sequelize-cli globally**
+
+```bash
+sudo npm i sequelize-cli -g
+```
+
+**Navigate to the src folder of notification service and run sequelize-cli migration command:**
+
+```bash
+cd ../../notification/src
+npx sequelize-cli db:migrate
+```
+
+## Start the Services
+
+Navigate to the src folder of notification service and run pm2 start command:
+
+```bash
+$ cd /opt/backend/notification/src
+notification/src$ pm2 start app.js -i 2 --name elevate-notification
+```
+
+#### Run pm2 ls command
+
+```bash
+$ pm2 ls
+```
+
+Output should look like this (Sample output, might slightly differ in your installation):
+
+```bash
+┌────┬─────────────────────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
+│ id │ name                    │ namespace   │ version │ mode    │ pid      │ uptime │ ↺    │ status    │ cpu      │ mem      │ user     │ watching │
+├────┼─────────────────────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
+│ 19 │ elevate-notification    │ default     │ 1.0.0   │ cluster │ 88026    │ 47h    │ 0    │ online    │ 0%       │ 113.2mb  │ jenkins  │ disabled │
+│ 20 │ elevate-notification    │ default     │ 1.0.0   │ cluster │ 88036    │ 47h    │ 0    │ online    │ 0%       │ 80.3mb   │ jenkins  │ disabled │
+└────┴─────────────────────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘
+```
+
+This concludes the services and dependency setup.