{"id":15653403,"url":"https://github.com/zurfyx/chat","last_synced_at":"2025-04-30T21:42:45.159Z","repository":{"id":79765782,"uuid":"70098409","full_name":"zurfyx/chat","owner":"zurfyx","description":"The open-source chat application for developers.","archived":false,"fork":false,"pushed_at":"2017-09-11T17:33:29.000Z","size":343,"stargazers_count":29,"open_issues_count":0,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-30T20:11:17.509Z","etag":null,"topics":["chat","developer","nodejs","react"],"latest_commit_sha":null,"homepage":"http://nyao.io:3000","language":"JavaScript","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/zurfyx.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-05T20:51:13.000Z","updated_at":"2024-04-08T17:50:17.000Z","dependencies_parsed_at":"2023-06-02T08:15:20.033Z","dependency_job_id":null,"html_url":"https://github.com/zurfyx/chat","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/zurfyx%2Fchat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurfyx%2Fchat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurfyx%2Fchat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zurfyx%2Fchat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zurfyx","download_url":"https://codeload.github.com/zurfyx/chat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251789034,"owners_count":21644075,"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","developer","nodejs","react"],"created_at":"2024-10-03T12:45:34.891Z","updated_at":"2025-04-30T21:42:45.125Z","avatar_url":"https://github.com/zurfyx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nyao - the open-source chat application for developers\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://circleci.com/gh/zurfyx/nyao\"\u003e\u003cimg src=\"https://circleci.com/gh/zurfyx/nyao.svg?style=shield\u0026circle-token=989c19693484a1e864875e0aa3f826d57cd2a235\" alt=\"CircleCI\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://travis-ci.com/zurfyx/nyao\"\u003e\u003cimg src=\"https://travis-ci.com/zurfyx/nyao.svg?token=kXP2msyJWy3GocoENpsq\u0026branch=master\" alt=\"Build Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://dependencyci.com/github/zurfyx/nyao\"\u003e\u003cimg src=\"https://dependencyci.com/github/zurfyx/nyao/badge\" alt=\"Dependency Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/zurfyx/nyao\"\u003e\u003cimg src=\"https://codecov.io/gh/zurfyx/nyao/branch/master/graph/badge.svg?token=fqr6VP4POE\" alt=\"Codecov\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/repos/588ce93fc323540054000f72/feed\"\u003e\u003cimg src=\"https://codeclimate.com/repos/588ce93fc323540054000f72/badges/6af06015c038b1ef6f6c/gpa.svg\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Getting started\n\n### Docker (quickest)\n\nIt is taken for granted that you have both [Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://docs.docker.com/compose/install/).\n\n```\ndocker-compose up\n```\nor\n\n```\ndocker-compose run --service-ports web npm start\n```\n\nOther [execution](#execution) options.\n\n### Node\n\nRequirements:\n\n- [Node.js](https://nodejs.org) (v6+) ([setup](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions))\n- [MongoDB](https://www.mongodb.com/) ([setup](https://www.digitalocean.com/community/tutorials/how-to-install-mongodb-on-ubuntu-16-04))\n- [Redis](https://redis.io) ([setup](https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-redis-on-ubuntu-16-04))\n\n```\nnpm install\n```\n\nStart MongoDB \u0026 Redis: *(skip this step if you have them running already)*\n\n```\nscripts/startdb.sh\n```\n\nRun the project (see [Execution](#execution) for alternative options):\n\n```\nnpm start\n```\n\n## Execution\n\nDefault (production):\n\n`npm start`\n\nProduction (backend only):\n\n`npm run start-prod-backend`\n\nProduction (frontend only):\n\n`npm run start-prod-frontend`\n\nDevelopment:\n\n`npm run start-dev`\n\nDevelopment (backend only):\n\n`npm run start-dev-backend`\n\nProduction (frontend only):\n\n`npm run start-dev-frontend`\n\n### Docker\n\nWhen using Docker, npm commands can be passed by overriding the default web command:\n\n```\ndocker-compose run --service-ports web npm start\n```\n\n#### Production\n\nProduction Docker Compose gathers the `latest` version from the Docker Hub.\n\n```\ndocker-compose -f docker-compose.yml -f docker-compose.prod.yml up\n```\n\n## Configuration\n\nThe default configuration file resides in `config/default.js`.\nYou can create your own configuration files that extend it that suit your own needs\n(configuration files are based on [config](https://github.com/lorenwest/node-config)).\n\nTo start, you should be creating a `config/production.js` or `config/development.js`, for\ndevelopment or production respectively, that looks like the following:\n\n```\nmodule.exports = {\n  passport: {\n    github: {\n      clientID: 'Github client ID',\n      clientSecret: 'GitHub secret key',\n      callbackURL: 'http://mydomain:3000/api/auth/github/callback',\n    },\n    google: {\n      clientID: 'Google client ID',\n      clientSecret: 'Google secret key',\n      callbackURL: 'http://mydomain:3000/api/auth/google/callback',\n    },\n  },\n}\n```\n\n## Development\n\n### Folder structure\n\n```\n.\n├── backend\n├── config\n├── data\n|    ├── db-data\n|    └── db-session\n├── docs\n├── frontend\n├── public\n├── scripts\n├── webpack\n├── .babelrc\n├── .editorconfig\n├── .eslintrc\n├── .gitignore\n├── .package.json\n├── .travis.yml\n└── README.md\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzurfyx%2Fchat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzurfyx%2Fchat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzurfyx%2Fchat/lists"}