add documentation

- update readme
- start documenting the repo

Author: Joey Goksu

README.md

@@ -1,12 +1,33 @@
+# NestJS Boilerplate
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![GitHub issues](https://img.shields.io/github/issues/joeygoksu/prime-nestjs.svg)
+[![Known Vulnerabilities](https://snyk.io/test/github/joeygoksu/prime-nestjs/badge.svg)](https://snyk.io/test/github/joeygoksu/prime-nestjs)
+![GitHub stars](https://img.shields.io/github/stars/joeygoksu/prime-nestjs.svg?style=social&label=Star&maxAge=2592000)
+
 <p align="left">
-  <img src="./showcase/prime-nestjs.jpg" width="600" alt="prime-nestjs">
+  <img src="documentation/prime-nestjs.jpg" width="600" alt="prime-nestjs">
 </p>
 
-Introducing the NestJS boilerplate, a comprehensive and modular starting point for your next Node.js project! Built with the latest version of NestJS, a powerful and flexible framework for building efficient and scalable server-side applications, this boilerplate includes support for TypeScript, PostgreSQL, and JWT authentication out of the box. Other features include configuration support with Dotenv, RBAC and CBAC for authorization, TypeORM for database interactions, Swagger for API documentation, and Docker Compose for container orchestration. Additionally, the boilerplate comes with pre-configured linting tools and secure HTTP headers with Helmet. Simply clone the repository, install the dependencies, and start building your next great idea!
+## 📖 Description
+
+![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)
+![Maintenance](https://img.shields.io/maintenance/yes/2021.svg)
+![GitHub last commit](https://img.shields.io/github/last-commit/joeygoksu/prime-nestjs.svg)
+![GitHub repo size](https://img.shields.io/github/repo-size/joeygoksu/prime-nestjs.svg)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/joeygoksu/prime-nestjs.svg)
+![GitHub top language](https://img.shields.io/github/languages/top/joeygoksu/prime-nestjs.svg)
+![GitHub language count](https://img.shields.io/github/languages/count/joeygoksu/prime-nestjs.svg)
+![GitHub contributors](https://img.shields.io/github/contributors/joeygoksu/prime-nestjs.svg)
+![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/y/joeygoksu/prime-nestjs.svg)
+![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/m/joeygoksu/prime-nestjs.svg)
+![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/w/joeygoksu/prime-nestjs.svg)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/joeygoksu/prime-nestjs.svg)
 
-## Out-of-box Solutions
+Introducing the NestJS boilerplate, a comprehensive and modular starting point for your next Node.js project! Built with the latest version of NestJS, a powerful and flexible framework for building efficient and scalable server-side applications, this boilerplate includes support for TypeScript, PostgreSQL, and JWT authentication out of the box. Other features include configuration support with Dotenv, RBAC and CBAC for authorization, TypeORM for database interactions, Swagger for API documentation, and Docker Compose for container orchestration. Additionally, the boilerplate comes with pre-configured linting tools and secure HTTP headers with Helmet. Simply clone the repository, install the dependencies, and start building your next great idea!
 
-**Built-in Features**
+## 🚀 Features
 
 - 📱 **NestJS** — latest version
 - 🎉 **TypeScript** - Type checking
@@ -23,9 +44,6 @@ Introducing the NestJS boilerplate, a comprehensive and modular starting point f
 - 📏 **ESLint** — Pluggable JavaScript linter
 - 💖 **Prettier** - Opinionated Code Formatter
 - ✨ **Commitlint** - Lint your conventional commits
-
-**GitHub actions**
-
 - 🕵️‍♂️ **Code Scanning** - Code scanning with CodeQL
 
 ## Quick Setup (Production)

documentation/Readme.md

@@ -0,0 +1,8 @@
+# Documentation
+
+This is the documentation for the project. It is written in Markdown and can be viewed in the browser.
+
+## Table of Contents
+
+- [Auth](./auth.md)
+- [Config](./config.md)

documentation/auth.md

@@ -0,0 +1,36 @@
+# Auth
+
+## Sequence Diagram
+
+```mermaid
+
+sequenceDiagram
+  autonumber
+  participant C as Client #1
+  participant AC as AuthController #2
+  participant AS as AuthService #3
+  participant US as UsersService #4
+
+  #1: Client - The user/client who sends the request to the server for login or register.
+  #2: AuthController - The controller that handles the incoming requests from the client, performs necessary validations and calls the AuthService to perform the login or register operation.
+  #3: AuthService - The service layer that processes the login or register request and performs necessary business logic such as authentication, generating JWT token, and validating user information using the UsersService.
+  #4: UsersService - The service layer that communicates with the database and fetches or modifies user information.
+
+  #1: C->>+AC: Sends login or register request to AuthController.
+  #2: AC->>+AS: Calls login or register function of AuthService.
+  #3: AS->>+US: Calls UsersService function to fetch or modify user information.
+  Note over US: UsersService communicates<br>with the database to fetch or<br>modify user information.
+
+  alt Valid user
+    #4: US-->>-AS: Returns user information.
+    #3: AS-->>-AC: Returns success message and JWT token.
+    #2: AC-->>-C: Returns success message and JWT token.
+    Note over C: Receives success message and JWT token.
+  else Invalid user
+    #4: US-->>-AS: Returns null.
+    #3: AS-->>-AC: Returns error message.
+    #2: AC-->>-C: Returns error message.
+    Note over C: Receives error message.
+  end
+
+```

documentation/config.md

@@ -0,0 +1,23 @@
+# Config
+
+## Sequence Diagram
+
+```mermaid
+sequenceDiagram
+  autonumber
+  participant ConfigLoader as Config Loader #1
+  participant Database as Database #2
+  participant App as App #3
+
+  #1: ConfigLoader - Loads the configuration file and initializes the application settings.
+  #2: Database - Connects to the database using the database configuration settings.
+  #3: App - Runs the application and listens for incoming requests.
+
+  #1: ConfigLoader->>+Database: Loads database configuration settings.
+  Note over Database: Connects to the database using<br>the configuration settings.
+  #2: Database-->>-ConfigLoader: Returns database connection status.
+  Note over ConfigLoader: Initializes the application settings using<br>the loaded configuration file.
+  #1: ConfigLoader->>+App: Loads application settings.
+  Note over App: Runs the application using the<br>initialized configuration settings.
+  #3: App-->>-ConfigLoader: Returns application status.
+```