{"id":23152498,"url":"https://github.com/1amageek/muni","last_synced_at":"2025-08-17T20:33:00.566Z","repository":{"id":62448126,"uuid":"142858586","full_name":"1amageek/Muni","owner":"1amageek","description":"Chat with Cloud Firestore","archived":false,"fork":false,"pushed_at":"2019-04-03T09:23:16.000Z","size":9696,"stargazers_count":23,"open_issues_count":1,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-18T04:44:47.810Z","etag":null,"topics":["chat","cloudfirestore","firebase","messaging"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1amageek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-30T10:05:19.000Z","updated_at":"2024-02-16T21:35:18.000Z","dependencies_parsed_at":"2022-11-02T01:01:17.826Z","dependency_job_id":null,"html_url":"https://github.com/1amageek/Muni","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1amageek%2FMuni","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1amageek%2FMuni/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1amageek%2FMuni/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1amageek%2FMuni/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1amageek","download_url":"https://codeload.github.com/1amageek/Muni/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230167887,"owners_count":18183846,"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":["chat","cloudfirestore","firebase","messaging"],"created_at":"2024-12-17T19:15:26.633Z","updated_at":"2024-12-17T19:15:27.501Z","avatar_url":"https://github.com/1amageek.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Muni\nChat framework\n\n\u003cimg src=\"https://github.com/1amageek/Muni/blob/master/sample.gif\" width=\"500\"\u003e\n\n# Feature 🎊\n\n☑️ **Serverless - Firebase Cloud Firestore**\u003cbr\u003e\n☑️ **Realtime**\u003cbr\u003e\n☑️ **Customizable**\u003cbr\u003e\n☑️ **Type Safe**\u003cbr\u003e\n☑️ **Multi Media**\n\n#### Media\n- Text\n- Image\n- Video\n- Audio\n- Location\n- Sticker\n- ImageMap\n\n\n# Installation ⚙\n\n`pod 'Muni'` add to your Podfile\n\n```\npod install\n```\n\n`GoogleService-Info.plist` add to your Project\n\n# Usage\n\n## Prepare three documents for cloud firestore.\n`UserProtocol` `RoomProtocol` `TranscriptProtocol` create document conforming to each protocol.\n\n``` swift\n@objcMembers\nclass User: Object, UserProtocol {\n    var name: String?\n    var thumbnailImage: File?\n}\n```\n\n``` swift\n@objcMembers\nclass Room: Object, RoomProtocol {\n    typealias TranscriptType = Transcript\n    dynamic var name: String?\n    dynamic var thumbnailImage: File?\n    dynamic var viewers: [String] = []\n    dynamic var members: [String] = []\n    dynamic var recentTranscript: [String: Any] = [:]\n    dynamic var transcripts: NestedCollection\u003cTranscriptType\u003e = []\n    dynamic var config: [String: Any] = [:]\n    dynamic var isMessagingEnabled: Bool = true\n    dynamic var isHidden: Bool = false\n    dynamic var lastViewedTimestamps: [String : Timestamp] = [:]\n}\n```\n\n``` swift\n@objcMembers\nclass Transcript: Object, TranscriptProtocol {\n    dynamic var to: Relation\u003cRoom\u003e = .init()\n    dynamic var from: Relation\u003cUser\u003e = .init()\n    dynamic var text: String?\n    dynamic var image: File?\n    dynamic var video: File?\n    dynamic var audio: File?\n    dynamic var location: GeoPoint?\n    dynamic var sticker: String?\n    dynamic var imageMap: [File] = []\n}\n```\n\n## Override two ViewControllers\n\n```swift\nclass MessageViewController: Muni\u003cUser, Room, Transcript\u003e.MessagesViewController {\n\n    var sendBarItem: ToolbarItem!\n\n    override var senderID: String? {\n        return Auth.auth().currentUser!.uid\n    }\n\n    override func viewDidLoad() {\n        super.viewDidLoad()\n        self.sendBarItem = ToolbarItem(title: \"Send\", target: self, action: #selector(send))\n        self.toolBar.setItems([ToolbarItem(customView: self.textView), self.sendBarItem], animated: false)\n        \n        // Start\n        self.listen()\n    }\n\n    override func transcript(willSend transcript: Transcript) -\u003e Bool {\n        guard let text: String = self.textView.text else { return false }\n        if text.isEmpty { return false }\n        transcript.text = text\n        self.textView.text = nil\n        return true\n    }\n}\n```\n\n```swift\nclass BoxViewController: Muni\u003cUser, Room, Transcript\u003e.InboxViewController {\n\n    override func viewDidLoad() {\n        super.viewDidLoad()\n\n        // Start\n        self.listen()\n    }\n\n    override func messageViewController(with room: Room) -\u003e Muni\u003cUser, Room, Transcript\u003e.MessagesViewController {\n        return MessageViewController(roomID: room.id)\n    }\n}\n```\n\n### Build\n\n\u003e Muni internally uses Firestore Query.\n\u003e An error occurs if there is no Index in Firestore. You can create an Index by accessing the URL on the console.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1amageek%2Fmuni","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1amageek%2Fmuni","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1amageek%2Fmuni/lists"}