This is a NestJS project bootstrapped using the Nest CLI.
- Node.js (LTS enforced)
- npm
Clone the repository and install dependencies:
git clone https://github.com/phertyameen/realTimeChat.git
cd realTimeChat
npm install
# Running the Application
Start the development server:
```npm run start
For hot reload:
```npm run start:dev
# Project Structure
src/ - Main application source code
main.ts - Entry point of the application
app.module.ts - Root module with TypeORM connection
config folder - contains appConfig and database configurations
app.controller.ts - Default controller
app.service.ts - Default service
# Installed Packages
@nestjs/config - Configuration management
@nestjs/typeorm - TypeORM integration
class-validator - Validation utilities
class-transformer - Transformation utilities
#Rules
Do not push directly to any branch.
Always create a new branch for your changes.
Open a pull request for review before merging.
Always use multi-line comment i.e (/**...*/) comment system instead of the double slash (//) for uproper documentation
#The keyboard shortcut for commenting
Multi-line comment: Shift + Alt + A (Windows/Linux) or Shift + Option + A (Mac)
#Useful Commands
npm run build - Build the project
npm run test - Run tests
#License
This project is licensed under the MIT License.