{"id":14989440,"url":"https://github.com/temzasse/yak-chat","last_synced_at":"2025-04-12T01:16:57.453Z","repository":{"id":87469974,"uuid":"105760074","full_name":"Temzasse/yak-chat","owner":"Temzasse","description":"A little real-time chat app with push notifications and offline support 🗣","archived":false,"fork":false,"pushed_at":"2017-12-15T21:01:33.000Z","size":3493,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-12T01:16:52.123Z","etag":null,"topics":["koajs","mobx","mobx-state-tree","mongodb","push-notifications","reactjs","socket-io","styled-components"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Temzasse.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":"2017-10-04T11:22:43.000Z","updated_at":"2024-03-30T23:56:15.000Z","dependencies_parsed_at":"2023-07-18T11:01:05.376Z","dependency_job_id":null,"html_url":"https://github.com/Temzasse/yak-chat","commit_stats":{"total_commits":76,"total_committers":4,"mean_commits":19.0,"dds":0.2894736842105263,"last_synced_commit":"ebf33eb821f433a121093610ff133b153850360c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Temzasse%2Fyak-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Temzasse%2Fyak-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Temzasse%2Fyak-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Temzasse%2Fyak-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Temzasse","download_url":"https://codeload.github.com/Temzasse/yak-chat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501859,"owners_count":21114684,"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":["koajs","mobx","mobx-state-tree","mongodb","push-notifications","reactjs","socket-io","styled-components"],"created_at":"2024-09-24T14:18:22.626Z","updated_at":"2025-04-12T01:16:57.415Z","avatar_url":"https://github.com/Temzasse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yak Chat\n\nYak Chat is a school project to research modern technologies such as WebSockets, Service Worker and offline storages to create an efficient and easy-to-use chat application.\n\nThe frontend is implemented with React, styled-components and mobx-state-tree, and the light-weight backend is built with Koa and MongoDB. Real-time communication is dealt with socket.io on both sides, and data is persisted with localStorage and the application caching is provided by create-react-app out of the box via a Service Worker.\n\n**Current features:**\n\n* Send and receive messages in real-time\n* Create multiple channels\n* Invite people to channels with a QR-code\n* Directly join channel by it's name\n* See how many people are currently in the channel\n* Automatically generate funny channel name suggestions\n\n---\n\n\u003cp align='center'\u003e\n  \u003cimg src=\"media/demo.gif\" width=\"70%\"/\u003e\n\u003cp/\u003e\n\n---\n\n## Requirements\n\n* [Docker](https://docs.docker.com/engine/installation/)\n* [Node.js](https://nodejs.org/en/download/)\n* [ngrok](https://ngrok.com/) (for production demo only)\n\n## Development\n\nFirst install linters:\n```\n$ npm install\n```\n\nThen start the app:\n```\n$ npm run up\n```\n\nThen open [localhost:3000](http://localhost:3000) in the browser.\n\n## Production demo\n\nBuild the production demo version with ngrok:\n\nFirst start ngrok:\n```\n$ ./ngrok http -region eu 3000\n```\n\nThen change the *API_URL* in `/client/src/config.js` to be the https url that ngrok outputs.\n\nThen build the demo:\n```\n$ npm run demo\n```\n\nIf you have made changes after last build re-build from scratch:\n```\n$ npm run demo:clean\n```\n### Handy commands\n\nRemove current containers:\n```\n$ npm run down\n```\n\nRemove current containers and rebuild them:\n```\n$ npm run clean:build\n```\n\nRemove node_modules and install packages:\n```\n$ npm run clean:install\n```\n\nWhen you add a new npm package you need to reinstall packages inside the Docker\ncontainer:\n```\n$ npm run reinstall:client\n$ npm run reinstall:server\n```\n## Screenshots\n\n\u003cp align='center'\u003e\n  \u003cimg src=\"media/screenshot_1.png\" width=\"100%\"/\u003e\n\u003cp/\u003e\n\n\u003cp align='center'\u003e\n  \u003cimg src=\"media/screenshot_2.png\" width=\"100%\"/\u003e\n\u003cp/\u003e\n\n\u003cp align='center'\u003e\n  \u003cimg src=\"media/screenshot_3.png\" width=\"100%\"/\u003e\n\u003cp/\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemzasse%2Fyak-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftemzasse%2Fyak-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemzasse%2Fyak-chat/lists"}