{"id":26264348,"url":"https://github.com/dru-blip/whisper-api","last_synced_at":"2026-04-11T04:32:14.183Z","repository":{"id":281836680,"uuid":"940499162","full_name":"Dru-blip/whisper-api","owner":"Dru-blip","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-07T17:09:56.000Z","size":670,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T18:25:44.526Z","etag":null,"topics":["mikro-orm","nestjs","postgresql","redis","socket-io","typescript","websockets"],"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/Dru-blip.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}},"created_at":"2025-02-28T09:32:52.000Z","updated_at":"2025-04-07T17:10:00.000Z","dependencies_parsed_at":"2025-04-07T18:24:09.844Z","dependency_job_id":"c35387d0-0d62-4340-912c-8f01a6b2f490","html_url":"https://github.com/Dru-blip/whisper-api","commit_stats":null,"previous_names":["dru-blip/whisper-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Dru-blip/whisper-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dru-blip%2Fwhisper-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dru-blip%2Fwhisper-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dru-blip%2Fwhisper-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dru-blip%2Fwhisper-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dru-blip","download_url":"https://codeload.github.com/Dru-blip/whisper-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dru-blip%2Fwhisper-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266417073,"owners_count":23925301,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["mikro-orm","nestjs","postgresql","redis","socket-io","typescript","websockets"],"created_at":"2025-03-14T02:14:47.062Z","updated_at":"2025-12-30T21:25:30.398Z","avatar_url":"https://github.com/Dru-blip.png","language":"TypeScript","readme":"# Whisper API\n\nThis repository provides a  API for Whisper clients, built using NestJS, MikroORM, TypeScript, PostgreSQL, Redis, Nodemailer, and Socket.IO.\n\n## Technologies\n\n-   **[NestJS](https://nestjs.com/):** A progressive Node.js framework for building efficient and scalable server-side applications.\n-   **[TypeScript](https://www.typescriptlang.org/):** A strongly typed programming language that builds on JavaScript.\n-   **[MikroORM](https://mikro-orm.io/):** A TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns.\n-   **[PostgreSQL](https://www.postgresql.org/):** A powerful, open-source relational database system.\n-   **[Redis](https://redis.io/):** An in-memory data structure store, used as a database, cache, and message broker.\n-   **[Nodemailer](https://nodemailer.com/about/):** A module for Node.js applications to send emails.\n-   **[Socket.IO](https://socket.io/):** A library that enables real-time, bidirectional, and event-based communication between web clients and servers.\n-   **Docker \u0026 Docker Compose:** Containerization and orchestration for easy deployment.\n\n## TODO List\n### Friend System\n-   [x] Create `FriendRequest` entity in MikroORM.\n-   [x] Implement API endpoints for sending, accepting, and declining friend requests.\n-   [x] Implement user search functionality.\n-   [x] **Real-time:** Implement Socket.IO event for new friend requests (`friendRequest:new`).\n-   [x] **Real-time:** Implement Socket.IO event for accepted friend requests (`friendRequest:accepted`).\n-   [x] **Real-time:** Implement Socket.IO event for declined friend requests (`friendRequest:declined`).\n-   [ ] **Real-time:** Implement Socket.IO event for when a user is blocked/unblocked (`user:blocked`, `user:unblocked`).\n\n### Conversations (Direct Messages)\n\n-   [ ] Create `Conversation` and `Message` entities.\n-   [ ] Implement real-time messaging via Socket.IO.\n    -   [ ] **Real-time:** Implement Socket.IO event for new messages (`message:new`).\n    -   [ ] **Real-time:** Implement Socket.IO event for message updates (edits, deletions) (`message:updated`).\n-   [ ] Implement message history retrieval.\n-   [ ] Implement message read receipts (optional).\n    -   [ ] **Real-time:** Implement Socket.IO event for message read receipts (`message:read`).\n\n### Channels (Group Conversations)\n\n-   [ ] Create `Channel`, `ChannelMembership`, and `ChannelMessage` entities.\n-   [ ] Implement channel creation and management endpoints.\n-   [ ] Implement real-time channel messaging.\n    -   [ ] **Real-time:** Implement Socket.IO event for new channel messages (`channelMessage:new`).\n    -   [ ] **Real-time:** Implement Socket.IO event for channel message updates (`channelMessage:updated`).\n-   [ ] Implement channel administration permissions.\n    -   [ ] **Real-time:** Implement Socket.IO event for user joins/leaves (`channel:userJoined`, `channel:userLeft`).\n    -   [ ] **Real-time:** Implement Socket.IO events for permission changes (`channel:permissionsUpdated`).\n-   [ ] Implement channel invites.\n    -   [ ] **Real-time:** Implement Socket.IO event for channel invites (`channel:invite`).\n\n### General\n\n-   [ ] Write unit and integration tests for all new features, including Socket.IO event handling.\n-   [ ] Improve API documentation, including Socket.IO event schemas.\n-   [ ] Refactor code for better organization, especially Socket.IO event handling.\n-   [ ] Implement efficient handling of Socket.IO connections and disconnections.\n-   [ ] Implement proper authentication and authorization for Socket.IO events.\n-   [ ] Implement robust error handling for Socket.IO events.\n-   [ ] Implement rate limiting for Socket.IO events.\n-   [ ] Consider using Redis Pub/Sub for scaling Socket.IO.\n\n\n## Prerequisites\n-   Node.js\n-   PostgreSQL\n-   Redis\n-   NPM\n-   docker and docker compose\n\n## Installation\n1.  **Clone the repository:**\n    ```bash\n    git clone https://github.com/Dru-blip/whisper-api.git\n    cd whisper-api\n    ```\n2.  **Install dependencies:**\n    ```bash\n    npm install # or yarn install\n    ```\n3.  **Configure environment variables:**\n\n    Create a `.env` file in the root directory and populate it with the necessary environment variables. Example:\n    ```\n    ACCESS_TOKEN_SECRET=\u003csecret\u003e\n    REFRESH_TOKEN_SECRET=\u003csecret\u003e\n    ONBOARDING_TOKEN_SECRET=\u003csecret\u003e\n    COOKIE_SECRET=\u003csecret\u003e\n    ACCESS_TOKEN_EXPIRY=15m\n    REFRESH_TOKEN_EXPIRY=7d\n    ONBOARDING_TOKEN_EXPIRY=30m\n    ```\n    ```\n    DB_NAME=\u003cdatabase_name\u003e\n    DB_PASSWORD=\u003cdatabase_password\u003e\n    DB_USER=\u003cdatabase_user\u003e\n    DB_PORT=5432\n    ```\n\n    ```\n    EMAIL_USER=\u003cgmail\u003e\n    EMAIL_PASS=\u003capp-password\u003e\n    ```\n\n4.  **Run database migrations:**\n\n    ```bash\n    npx mikro-orm migration:create --initial\n    npx mikro-orm migration:up\n    ```\n5. **Running Docker containers**\n    ```\n        docker compose up\n    ```\n\n5.  **Start the development server:**\n\n    ```bash\n    npm run start:dev # or yarn start:dev\n    ```\n\n\n## Contributing\nContributions are welcome! Please feel free to submit a pull request or open an issue.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdru-blip%2Fwhisper-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdru-blip%2Fwhisper-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdru-blip%2Fwhisper-api/lists"}