{"id":15435398,"url":"https://github.com/neuodev/receptor","last_synced_at":"2025-04-19T18:20:50.532Z","repository":{"id":61399861,"uuid":"524019560","full_name":"neuodev/receptor","owner":"neuodev","description":"Real-time messaging app. Available as a website and as MacOS, Linux, and Windows application.","archived":false,"fork":false,"pushed_at":"2022-11-04T04:02:15.000Z","size":14067,"stargazers_count":22,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-02T07:02:46.438Z","etag":null,"topics":["chatapp","javascript","postgresql","react","rust","socket-io","tauri","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/neuodev.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}},"created_at":"2022-08-12T08:56:19.000Z","updated_at":"2025-02-07T21:42:17.000Z","dependencies_parsed_at":"2023-01-21T12:34:09.040Z","dependency_job_id":null,"html_url":"https://github.com/neuodev/receptor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuodev%2Freceptor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuodev%2Freceptor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuodev%2Freceptor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neuodev%2Freceptor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neuodev","download_url":"https://codeload.github.com/neuodev/receptor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241551961,"owners_count":19981050,"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":["chatapp","javascript","postgresql","react","rust","socket-io","tauri","typescript","websockets"],"created_at":"2024-10-01T18:44:09.329Z","updated_at":"2025-03-02T18:32:13.341Z","avatar_url":"https://github.com/neuodev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Receptor\n\nReal-time messaging app. Available as a web, MacOS, Linux, and Windows application.\n\n\u003cp align=\"center\"\u003e \n   \u003cimg src=\"https://user-images.githubusercontent.com/72753578/184505323-7f76a321-28cc-480a-ac9a-ec72a3fd91de.gif\" alt=\"Logo\" title=\"Receptor\"/\u003e\n\u003c/p\u003e\n\n![group_chat](./preview/group_chat.png)\n![friends](./preview/friends.png)\n\n\u003cdetails\u003e\n\u003csummary\u003eSee more?\u003c/summary\u003e\n\n![receptor-chat](./preview/chat.png)\n![receptor-chat](./preview/closed_group.png)\n![receptor-chat](./preview/empty.png)\n![receptor-chat](./preview/sign_in.png)\n\n\u003c/details\u003e\n\n## [Database Schema](https://drawsql.app/teams/no-sim/diagrams/rustchat)\n\n![Schema](./schema.png)\n\n## Events\n\n```ts\n// Websocket events\nenum Event {\n  Connect = \"connect\",\n  Disconnect = \"disconnect\",\n  AddFriend = \"addFriend\",\n  AcceptFriend = \"acceptFriend\",\n  RemoveFriend = \"removeFriend\",\n  Notification = \"notification\",\n  Login = \"login\",\n  Logout = \"logout\",\n  GetUser = \"getUser\",\n  JoinRoom = \"joinRoom\",\n  LeaveRoom = \"leaveRoom\",\n  RoomMessage = \"sendRoomMsg\",\n  UpdateUser = \"updateUser\",\n}\n```\n\n## API\n\nFor full API documentation try import this [postman collection](./receptor-api.postman_collection.json)\n\n\u003cdetails\u003e\n   \u003csummary\u003e\n      Register - POST /api/v1/user/register\n   \u003c/summary\u003e\n\n### Reqeust\n\n```ts\ntype Body = {\n  username: string;\n  email: string;\n  password: string;\n};\n```\n\n### Response\n\n```ts\ntype Response = {\n  userId: number;\n};\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n   \u003csummary\u003e\n      Login - POST /api/v1/user/login\n   \u003c/summary\u003e\n\n### Reqeust\n\n```ts\ntype Body = {\n  email: string;\n  password: string;\n};\n```\n\n### Response\n\n```ts\ntype Response = {\n  user: User;\n  token: string;\n};\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Get users - GET /api/v1/user\n  \u003c/summary\u003e\n\n### Reqeust\n\n| Query Param. | Description                      | Type   | Default      |\n| ------------ | -------------------------------- | ------ | ------------ |\n| q            | Search by `email` and `username` | string | Empty string |\n| page         | Number of the current page       | number | 1            |\n| limit        | Number of items per response     | number | 10           |\n\n### Response\n\n```ts\ntype Reponse = {\n  users: Array\u003cUser\u003e;\n  count: number;\n};\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Get friends - GET /api/v1/user/friends\n  \u003c/summary\u003e\n\n### Reqeust\n\nAccess only by authorized users\n\n```ts\ntype Headers = {\n  authorization: string; // Bearer auth token\n};\n```\n\n### Response\n\n```ts\ntype Reponse = Array\u003cUser \u0026 { roomId: number }\u003e;\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Get room messages - GET /api/v1/room/:roomId\n  \u003c/summary\u003e\n\n### Reqeust\n\nAccess only by authorized users\n\n```ts\ntype Headers = {\n  authorization: string; // Bearer auth token\n};\n```\n\n### Response\n\n```ts\ntype Reponse = Array\u003cMessage \u0026 { user: User }\u003e;\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Get user groups - GET /api/v1/group\n  \u003c/summary\u003e\n\n### Reqeust\n\nAccess only by authorized users\n\n```ts\ntype Headers = {\n  authorization: string; // Bearer auth token\n};\n```\n\n### Response\n\n```ts\ntype Reponse = Array\u003c{\n  id: number;\n  name: string;\n  type: string;\n  createdAt: Date;\n  updatedAt: Data;\n  participants: Array\u003cUser\u003e;\n}\u003e;\n```\n\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Create new group- POST /api/v1/group\n  \u003c/summary\u003e\n\n### Reqeust\n\n```ts\ntype Body = {\n  groupName: string;\n  userIds: number[];\n};\n```\n\n### Response\n\n```ts\ntype Reponse = {\n  roomId: number;\n};\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Delete group - DELETE /api/v1/group/:groupId - Owner only\n  \u003c/summary\u003e\n\n### Reqeust\n\nAccess only by authorized users\n\n```ts\ntype Headers = {\n  authorization: string; // Bearer auth token\n};\n```\n\n### Response\n\n```ts\ntype Reponse = {\n  roomId: number;\n};\n```\n\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003e\n    Leave group - DELETE /api/v1/group/:groupId/leave \n  \u003c/summary\u003e\n\n### Reqeust\n\nAccess only by authorized users\n\n```ts\ntype Headers = {\n  authorization: string; // Bearer auth token\n};\n```\n\n### Response\n\n```ts\ntype Reponse = {\n  roomId: number;\n};\n```\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneuodev%2Freceptor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneuodev%2Freceptor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneuodev%2Freceptor/lists"}