{"id":28543268,"url":"https://github.com/orgball2608/nestchatapp","last_synced_at":"2025-07-06T10:32:15.980Z","repository":{"id":135314926,"uuid":"572079347","full_name":"orgball2608/NestChatApp","owner":"orgball2608","description":"Realtime Chat App (Nestjs, TypeOrm, MySQL,WebSocket, Docker)","archived":false,"fork":false,"pushed_at":"2025-07-03T00:38:48.000Z","size":491,"stargazers_count":12,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-03T01:27:37.435Z","etag":null,"topics":["amazon-s3","ci","docker","docker-compose","emit-events","multer","mysql-database","nestjs","nodejs","renovate","typeorm","typescript","websocket"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orgball2608.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-11-29T14:08:19.000Z","updated_at":"2025-07-03T00:38:49.000Z","dependencies_parsed_at":"2025-04-04T20:27:33.717Z","dependency_job_id":"ec966cb7-5c46-48b7-8398-dff05932f103","html_url":"https://github.com/orgball2608/NestChatApp","commit_stats":null,"previous_names":["orgball2608/nestchatapp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/orgball2608/NestChatApp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orgball2608%2FNestChatApp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orgball2608%2FNestChatApp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orgball2608%2FNestChatApp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orgball2608%2FNestChatApp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orgball2608","download_url":"https://codeload.github.com/orgball2608/NestChatApp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orgball2608%2FNestChatApp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263885099,"owners_count":23525020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amazon-s3","ci","docker","docker-compose","emit-events","multer","mysql-database","nestjs","nodejs","renovate","typeorm","typescript","websocket"],"created_at":"2025-06-09T21:08:35.450Z","updated_at":"2025-07-06T10:32:15.975Z","avatar_url":"https://github.com/orgball2608.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NestChatApp\n\n## Overview\nNestChatApp is a real-time chat application built using NestJS, TypeORM, MySQL, WebSocket, and Docker. This project aims to provide a scalable and efficient server-side application for real-time communication.\n\n## Features\n- **Real-time communication** using WebSocket (Socket.io) and Event emitters.\n- **REST API** for handling various endpoints.\n- **MySQL** as the main database.\n- **TypeORM** for object-relational mapping.\n- **AWS S3** for image uploads.\n- **Docker** for containerization and easy deployment.\n- **Session-based authentication** for secure user management.\n\n## Table of Contents\n1. [Installation \u0026 Setup](#installation-setup)\n2. [Running the Application](#running-the-application)\n3. [Implementation Details](#implementation-details)\n4. [Contributing](#contributing)\n5. [Troubleshooting](#troubleshooting)\n6. [License](#license)\n\n## Installation \u0026 Setup\n\n### Pre-requisites\n- Node.js v16\n- TypeORM (version 0.2.37 is used in this project)\n- MySQL Server (or any SQL database supported by TypeORM)\n\n### Setting up the Backend\n1. **Clone the repository**:\n    ```bash\n    git clone https://github.com/orgball2608/NestChatApp.git\n    cd NestChatApp\n    ```\n\n2. **Install the dependencies**:\n    - Then, install all the other dependencies:\n        ```bash\n        npm install\n        ```\n\n3. **Create a `.env.development` file** in the root directory and paste the following:\n    ```plaintext\n    PORT=\u003cyour_port\u003e\n    MYSQL_DB_HOST=\u003cyour_mysql_host\u003e\n    MYSQL_DB_USERNAME=\u003cyour_mysql_username\u003e\n    MYSQL_DB_PASSWORD=\u003cyour_mysql_password\u003e\n    MYSQL_DB_PORT=\u003cyour_mysql_port\u003e\n    MYSQL_DB_DATABASE=\u003cyour_mysql_database\u003e\n    SESSION_SECRET=\u003cyour_session_secret\u003e\n    COOKIE_SECRET=\u003cyour_cookie_secret\u003e\n    AWS_ACCESS_KEY_ID=\u003cyour_aws_access_key_id\u003e\n    AWS_SECRET_ACCESS_KEY=\u003cyour_aws_secret_access_key\u003e\n    AWS_PUBLIC_BUCKET_KEY=\u003cyour_aws_public_bucket_key\u003e\n    AWS_REGION=\u003cyour_aws_region\u003e\n    ```\n\n4. **Start the application in development mode**:\n    ```bash\n    npm run start:dev\n    ```\n\n## Running the Application\n\n### Local Run\nTo run the application locally, you will need Docker and docker-compose.\n\n1. **Run using npm**:\n    ```bash\n    npm run start:dev\n    ```\n\n2. **Run using Docker**:\n    ```bash\n    docker-compose up\n    ```\n\n## Implementation Details\n\n### Project Structure\n```plaintext\n.\n├── src\n│   ├── attachments\n│   ├── auth\n│   ├── conversations\n│   ├── friend-requests\n│   ├── friends\n│   ├── gateway\n│   ├── groups\n│   ├── messages\n│   ├── reacts\n│   ├── storage\n│   ├── users\n│   ├── utils\n│   ├── app.module.ts\n│   └── main.ts\n└── test\n```\n\n### Key Components\n- **REST API**: Handles API requests and responses.\n- **WebSocket**: Manages real-time communication.\n- **MySQL**: Database for storing application data.\n- **TypeORM**: Maps TypeScript objects to database tables.\n- **AWS S3**: Manages image uploads and storage.\n- **Docker**: Containerizes the application for easy deployment.\n\n## Contributing\nContributions are welcome! Please follow these steps to contribute:\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -m 'Add some feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Open a pull request.\n\n## Troubleshooting\n- Ensure all environment variables are correctly set.\n- Verify the MySQL server is running and accessible.\n- Check Docker and docker-compose installations.\n- For any issues, please open a GitHub issue.\n\n## License\nThis project is licensed under the UNLICENSED License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forgball2608%2Fnestchatapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forgball2608%2Fnestchatapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forgball2608%2Fnestchatapp/lists"}