{"id":19642107,"url":"https://github.com/kartikmanimuthu/phoenix-websocket-notifier","last_synced_at":"2026-04-09T18:12:23.276Z","repository":{"id":184423321,"uuid":"671850701","full_name":"kartikmanimuthu/phoenix-websocket-notifier","owner":"kartikmanimuthu","description":"A high-performance real-time notification system built with Node.js, Express, Socket.io, and Redis.","archived":false,"fork":false,"pushed_at":"2023-07-28T10:07:34.000Z","size":85,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-09T19:49:35.966Z","etag":null,"topics":["docker","expressjs","nodejs","redis","socket-io","socket-programming","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/kartikmanimuthu.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}},"created_at":"2023-07-28T09:31:12.000Z","updated_at":"2023-07-28T10:02:30.000Z","dependencies_parsed_at":"2023-07-28T12:00:59.508Z","dependency_job_id":null,"html_url":"https://github.com/kartikmanimuthu/phoenix-websocket-notifier","commit_stats":null,"previous_names":["karthikmani345/phoenix-websocket-notifier","kartikmanimuthu/phoenix-websocket-notifier"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartikmanimuthu%2Fphoenix-websocket-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartikmanimuthu%2Fphoenix-websocket-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartikmanimuthu%2Fphoenix-websocket-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartikmanimuthu%2Fphoenix-websocket-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kartikmanimuthu","download_url":"https://codeload.github.com/kartikmanimuthu/phoenix-websocket-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240947662,"owners_count":19883032,"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":["docker","expressjs","nodejs","redis","socket-io","socket-programming","websocket"],"created_at":"2024-11-11T14:11:34.774Z","updated_at":"2026-04-09T18:12:23.226Z","avatar_url":"https://github.com/kartikmanimuthu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003ePhoenix Websocket Notifier\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Karthikmani345/phoenix-websocket-notifier/actions\"\u003e\u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/workflow/status/Karthikmani345/phoenix-websocket-notifier/Node.js%20CI?style=for-the-badge\"\u003e\u003c/a\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Karthikmani345/phoenix-websocket-notifier/blob/main/LICENSE\"\u003e\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/Karthikmani345/phoenix-websocket-notifier?style=for-the-badge\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eA high-performance real-time notification system built with Node.js, Express, Socket.io, and Redis.\u003c/b\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n## 🛠️ Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- Docker and Docker-compose\n- Node.js 14.0 or higher\n- Redis 6.0 or higher\n\n## 🚀 Getting Started\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/Karthikmani345/phoenix-websocket-notifier.git\ncd phoenix-websocket-notifier\nnpm install\n```\n\n### 🔧 Local Setup\n\nCreate a `.env` file in your root directory and provide your local setup configurations as per the `.env.example` file in the repository.\n\nAfter configuring the environment variables, you can start the server in development mode:\n\n```bash\nnpm run start:dev\n```\n\nTo access the app, navigate to [`localhost:4000`](http://localhost:4000) from your browser.\n\nFor running the Redis server locally, you may need to install Redis on your machine and start the Redis server:\n\n```bash\nredis-server\n```\n\n### 🐳 Docker Setup\n\nBuild and start the Docker containers:\n\n```bash\ndocker-compose up --build\n```\n\n### 🐞 Debugging\n\nFor debugging, you can use:\n\n```bash\nnpm run debug:vs\n```\n\nYou can then attach a debugger to your running app on the port specified in your `.env` file.\n\n## 🎮 Usage\n\nUse the following commands as per your requirements:\n\n- Clean the dist directory: `npm run clean`\n\n## 🧪 Testing\n\nTest cases and relevant documentation are in progress and will be updated soon.\n\n## 🤝 How to Contribute\n\nLove this project? Great! We're open to contributions. To start, you can:\n\n1. Fork this repository\n2. Create your branch: `git checkout -b my-feature`\n3. Commit your changes: `git commit -m \"Add my feature\"`\n4. Push to your branch: `git push origin my-feature`\n5. Create a pull request!\n\nRead our [contributing guide](./CONTRIBUTING.md) for more info.\n\n## 📜 License\n\nPhoenix Websocket Notifier is [ISC licensed](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartikmanimuthu%2Fphoenix-websocket-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkartikmanimuthu%2Fphoenix-websocket-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartikmanimuthu%2Fphoenix-websocket-notifier/lists"}