docs: add docs for api and portal (#31)

Author: xixas

apps/api/README.md

@@ -1,73 +1,29 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
-</p>
+## Get Started
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
+1. **Installation:** Clone the repository and follow our simple setup guide.
+2. **Create Notifications:** Easily create and customize notifications for different channels. Use your own API or our API to update the notification database.
+3. **Sit Back and Relax:** Let our app handle the delivery and status tracking.
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+## Documentation
 
-## Description
+- [Development Setup](docs/development-setup.md)
+- [Production Setup](docs/production-setup.md)
+- [Usage Guide](docs/usage-guide.md)
+- [Block Diagram](docs/block-diagram.md)
+- [Database Design](docs/database-design.md)
+- [API Documentation](docs/api-documentation.md)
+- [API Test Cases](docs/api-test-cases.md)
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+## Contributing
 
-## Installation
+We welcome contributions from the community! If you're interested in contributing to the Transcript Summarizer, please take a moment to review our [Contribution Guidelines](../../CONTRIBUTING.md).
 
-```bash
-$ npm install
-```
+Your contributions help make our app even better. Whether you're a developer, designer, or just enthusiastic about enhancing user experiences, we'd love to have you on board.
 
-## Running the app
+Before you get started, please familiarize yourself with our guidelines to ensure a smooth collaboration process.
 
-```bash
-# development
-$ npm run start
-
-# watch mode
-$ npm run start:dev
-
-# production mode
-$ npm run start:prod
-```
-
-## Test
-
-```bash
-# unit tests
-$ npm run test
-
-# e2e tests
-$ npm run test:e2e
-
-# test coverage
-$ npm run test:cov
-```
-
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
-
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+[Contribution Guidelines](../../CONTRIBUTING.md)
 
 ## License
 
-Nest is [MIT licensed](LICENSE).
+This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.

apps/api/docs/api-documentation.md

@@ -0,0 +1 @@
+# TODO

apps/api/docs/api-test-cases.md

@@ -0,0 +1 @@
+# TODO

apps/api/docs/development-setup.md

@@ -1,25 +1,25 @@
 # Development Setup
 
-This document outlines the steps required to set up your Transcript Summarization for development. By following these steps, you'll be able to run your application locally with the necessary environment variables and database configuration.
+This document outlines the steps required to set up your Transcript Summarizer API for development. By following these steps, you'll be able to run your application locally with the necessary environment variables and database configuration.
 
 ## Prerequisites
 
-Before setting up Transcript Summarization for development, ensure you have the following prerequisites with the specified versions:
+Before setting up Transcript Summarizer API for development, ensure you have the following prerequisites with the specified versions:
 
 - **NVM (Node Version Manager):** Use NVM to manage Node.js versions.
-- **Node.js:** Node.js v20.x or higher can be installed via `nvm` using `nvm install 20` and used with `nvm use 20`.
+- **Node.js** Node.js v20.x or higher. Can be installed via `nvm` using `nvm install 20` and used with `nvm use 20`.
 - **Git:** Git v2.x or higher.
 - **MariaDB:** MariaDB v10.x or higher.
+- **Redis:** Redis v6.x or higher
 
-These prerequisites are essential for deploying and running Transcript Summarization in an environment.
+These prerequisites are essential for deploying and running Transcript Summarizer API in an environment.
 
 Please make sure to have these versions installed on your development server before proceeding with the setup.
 
-Make sure the MariaDB server is up and running.
-# This command checks if the MariaDB server is active and running.
-sudo systemctl status mariadb
+Make sure Redis and MariaDB server are up and running.
 
 ```bash
+sudo systemctl status redis
 sudo systemctl status mariadb
 ```
 
@@ -28,7 +28,7 @@ sudo systemctl status mariadb
 1. Clone the repository to your local machine:
 
    ```sh
-   git clone https://github.com/OsmosysSoftware/osm-transcript-summarizer
+   git clone https://github.com/OsmosysSoftware/osm-transcript-summarizer.git
    cd osm-transcript-summarizer/apps/api
    ```
 
@@ -41,18 +41,34 @@ sudo systemctl status mariadb
 3. Create a `.env` file in the project root and add the required environment variables:
 
    ```env
+   # Server
+   SERVER_PORT=3000
 
    # Node env
-   NODE_ENV=development
+   NODE_ENV=development # Use "development" for graphql playground to work
+
+   # Upload folder location
+   UPLOAD_FOLDER_PATH= # If not present will use "uploads" folder in the root cwd
 
    # Database configuration
-   DB_TYPE=mariadb
-   DB_HOST=localhost # use value as transcriptsummary-mariadb in docker
-   DB_PORT=3333
-   DB_USERNAME=root
-   DB_PASSWORD=your-password
-   DB_NAME=your-database
-   
+   DB_TYPE=
+   DB_HOST=transcript-summarizer-mariadb
+   DB_PORT=
+   DB_USERNAME=
+   DB_PASSWORD=
+   DB_NAME=
+   MARIADB_DOCKER_PORT= 3307
+
+   # Redis configuration
+   DB_HOST=transcript-summarizer-redis
+   REDIS_PORT=6379
+   REDIS_DOCKER_PORT=6379
+
+   OPENAI_API_KEY="sk-your api key"
+   GPT_MODEL="gpt-4o"
+
+   # Docker env
+   COMPOSE_PROJECT_NAME=transcript-summarizer-api 
    ```
 
    Alternatively, use the `.env.example` file instead.
@@ -75,4 +91,4 @@ sudo systemctl status mariadb
    npm run start:dev
    ```
 
-   Transcript Summarization will now be running locally at `http://localhost:3000`.
+   Transcript Summarizer API will now be running locally at `http://localhost:3000`.

apps/api/docs/production-setup.md

@@ -0,0 +1,162 @@
+# Production Setup
+
+This document outlines the steps required to set up Transcript Summarizer API for production. Following these steps will ensure that your application is configured properly for a production environment.
+
+## Prerequisites
+
+Before setting up Transcript Summarizer API for production, ensure you have the following prerequisites with the specified versions:
+
+- **NVM (Node Version Manager):** Use NVM to manage Node.js versions.
+- **Node.js** Node.js v20.x or higher.
+- **Git:** Git v2.x or higher.
+- **MariaDB:** MariaDB v10.x or higher.
+- **Redis:** Redis v6.x or higher
+- **PM2 (Process Manager):** PM2 v5.x or higher.
+
+These prerequisites are essential for deploying and running Transcript Summarizer API in a environment.
+
+Make sure Redis and MariaDB server are up and running.
+
+## Server Configuration
+
+1. **Environment Variables:** Set the necessary environment variables on your production server. These variables include database configuration, SMTP settings, and any other variables your application requires. Ensure the `.env` file is properly configured with production values.
+
+   ```env
+   # Server
+   SERVER_PORT=3000
+
+   # Node env
+   NODE_ENV=development # Use "development" for graphql playground to work
+
+   # Upload folder location
+   UPLOAD_FOLDER_PATH= # If not present will use "uploads" folder in the root cwd
+
+   # Database configuration
+   DB_TYPE=
+   DB_HOST=transcript-summarizer-mariadb
+   DB_PORT=
+   DB_USERNAME=
+   DB_PASSWORD=
+   DB_NAME=
+   MARIADB_DOCKER_PORT= 3307
+
+   # Redis configuration
+   DB_HOST=transcript-summarizer-redis
+   REDIS_PORT=6379
+   REDIS_DOCKER_PORT=6379
+
+   OPENAI_API_KEY="sk-your api key"
+   GPT_MODEL="gpt-4o"
+
+   # Docker env
+   COMPOSE_PROJECT_NAME=transcript-summarizer-api 
+   ```
+
+Make sure to replace the above example values with appropriate values as per your setup and configuration. Server Port is `3000`, you can update it if you want to use a different port of your choice.
+
+## Building and Preparing
+
+1. **Build the Application:** Before starting the server, build Transcript Summarizer API by running:
+
+   ```sh
+   npm run build
+   ```
+
+  This command compiles your TypeScript code into JavaScript and generates the necessary build files.
+
+## Starting the Server
+### Using PM2
+1. **PM2 Configuration:** Create an ecosystem.config.js (or .ts) file to configure PM2. This file defines settings such as the application name, entry point, and other options. For example:
+
+  ```js
+  module.exports = {
+    apps: [
+      {
+        name: 'Transcript-Summarizer-API', // Name of your application
+        script: 'dist/main.js', // Path to the compiled NestJS entry file
+        instances: 1, // Use max to Automatically scale instances based on CPU cores
+        autorestart: true, // Auto-restart if the app crashes
+        watch: false, // Watch for file changes (disable for production)
+        max_memory_restart: '1G', // Restart if memory usage exceeds 1GB
+        env: {
+          NODE_ENV: 'production', // Set the environment to production
+        },
+      },
+    ],
+  };
+  ```
+
+2. **Start the Application with PM2:** Use PM2 to start your application:
+
+  ```sh
+  pm2 start ecosystem.config.js
+  ```
+
+To ensure your application starts on system boot:
+
+  ```sh
+  pm2 startup
+  ```
+
+Follow instruction given by the command if any.
+
+Save pm2 config:
+
+  ```sh
+  pm2 save
+  ```
+### Using Docker
+
+**Step 1: Update Environment Variables**
+
+Before using Docker, ensure you've configured the environment variables in your `.env` file correctly. Update values such as `MARIADB_DOCKER_PORT`, `REDIS_DOCKER_PORT`, `REDIS_HOST`, and `DB_HOST` as required for your Docker setup.
+
+**Step 2: Build your docker container**
+
+```bash
+docker-compose build
+```
+
+**Step 3: Start the Docker Containers**
+
+To start your application within Docker containers, run the following command:
+
+```bash
+docker-compose up -d
+```
+
+**Step 4: Database Migrations (First-Time Setup)**
+
+For the first-time setup, you need to run database migrations to create the required database tables. Execute the following command:
+
+```bash
+docker exec -it transcript-summarizer-api npm run typeorm:run-migrations
+```
+
+**Step 5: Update Environment Variables**
+
+If you need to update any environment variable values:
+
+1. Update the values in your `.env` file.
+
+2. Stop the running containers:
+
+   ```bash
+   docker-compose down
+   ```
+
+3. Rebuild the Docker containers with the updated environment variables:
+
+   ```bash
+   docker-compose build
+   ```
+
+4. Start the Docker containers again:
+
+   ```bash
+   docker-compose up -d
+   ```
+
+With these steps, your application should be up and running in Docker with the updated environment variables.
+
+For details on using the application and making API calls, refer to our [Usage Guide](usage-guide.md).

apps/api/docs/usage-guide.md

@@ -0,0 +1 @@
+# TODO