{"id":19603126,"url":"https://github.com/hack-chat/hackchat-server","last_synced_at":"2025-02-26T15:43:07.851Z","repository":{"id":57151275,"uuid":"400027558","full_name":"hack-chat/hackchat-server","owner":"hack-chat","description":"A module-based websocket relay server","archived":false,"fork":false,"pushed_at":"2023-12-30T03:31:03.000Z","size":216,"stargazers_count":26,"open_issues_count":0,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-09T11:04:25.317Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/hack-chat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"patreon":"marzavec","ko_fi":"marzavec"}},"created_at":"2021-08-26T03:24:01.000Z","updated_at":"2024-08-02T02:19:47.000Z","dependencies_parsed_at":"2024-11-11T09:40:10.261Z","dependency_job_id":null,"html_url":"https://github.com/hack-chat/hackchat-server","commit_stats":{"total_commits":37,"total_committers":1,"mean_commits":37.0,"dds":0.0,"last_synced_commit":"820c062b58ca2b4972b8cfab7e317b3ceceb86c1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hack-chat%2Fhackchat-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hack-chat%2Fhackchat-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hack-chat%2Fhackchat-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hack-chat%2Fhackchat-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hack-chat","download_url":"https://codeload.github.com/hack-chat/hackchat-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240886563,"owners_count":19873528,"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":[],"created_at":"2024-11-11T09:28:13.848Z","updated_at":"2025-02-26T15:43:07.827Z","avatar_url":"https://github.com/hack-chat.png","language":"JavaScript","funding_links":["https://patreon.com/marzavec","https://ko-fi.com/marzavec","https://www.patreon.com/marzavec"],"categories":[],"sub_categories":[],"readme":"[![NPM version](https://img.shields.io/npm/v/hackchat-server.svg?maxAge=3600)](https://www.npmjs.com/package/hackchat-server)\n[![NPM downloads](https://img.shields.io/npm/dt/hackchat-server.svg?maxAge=3600)](https://www.npmjs.com/package/hackchat-server)\n[![travis build](https://img.shields.io/travis/hack-chat/hackchat-server.svg?style=flat)](https://travis-ci.org/hack-chat/hackchat-server)\n[![Dependency Status](https://david-dm.org/hack-chat/hackchat-server.svg?theme=shields.io)](https://david-dm.org/hack-chat/hackchat-server)\n[![Codecov](https://img.shields.io/codecov/c/github/hack-chat/hackchat-server.svg)](https://app.codecov.io/gh/hack-chat/hackchat-server)\n[![Language grade: JS/TS](https://img.shields.io/lgtm/grade/javascript/github/hack-chat/hackchat-server.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/hack-chat/hackchat-server/context:javascript)\n[![MIT License](https://img.shields.io/github/license/hack-chat/hackchat-server.svg?style=flat)](http://opensource.org/licenses/MIT)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat)](https://github.com/semantic-release/semantic-release)\n[![Patreon](https://img.shields.io/badge/donate-patreon-orange.svg)](https://www.patreon.com/marzavec)\n\n\n## Table of contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Example Usage](#example-usage)\n- [Links](#links)\n- [Languages](#languages)\n- [Contributing](#contributing)\n\n## About\n\nhackchat-server is a general use websocket server module designed to quickly bootstrap an application. The protocol is json only, with a module-based RPC-style command structure.\n\n- Hot reload support\n  - Update code without losing current connections\n- Built in ratelimiting \u0026 ip ban\n- Simple statistics tracking\n- Self documenting [*](#standard-modules)\n- Session recovery [*](#standard-modules)\n- Multi-language support\n- Quick module boilerplate generation\n  - `npx hc-generate-cmd`\n\n## Installation\n\n**Node.js (version 14.0) or newer is required.**\n\nAdd to your project with `npm install hackchat-server --save`.\n\nOnce installed, run `npx hc-config` to generate a config file. Skip this step if you are using an existing config file.\n\nNext, you may choose to run `npx hc-import` and import the [standard modules](#standard-modules). You should, at minimum, import the internal/* modules, unless you're working with existing command module files.\nThe hc-import script will accept a `--remote` argument to import remote command modules, like `npx hc-import --remote=https://github.com/someUser/command-modules.git`. (Note: currently this feature is unavailable)\n\nOr use `npx hc-generate-cmd` to quickly generate boilerplate modules.\n\nAll `hc-config`, `hc-import` \u0026 `hc-generate-cmd` scripts support multiple languages via the `--lang` argument. See example values in [languages section](#languages). Example: `hc-generate-cmd --lang=fr`\n\n## Example usage\n\n```js\nimport { CoreApp } from 'hackchat-server';\n\nconst server = new CoreApp({\n  configPath: '.hcserver.json',\n  logErrDetailed: true,\n  lang: 'en',\n});\n\nserver.init();\n```\n\n## Standard Modules\n\n1) `internal\\disconnect.js`\nCLient disconnection event handler\n2) `internal\\socketreply.js`\nClient error/warn event handler\n3) `remote\\session.js`\nStandard remote session handler\n4) `utility\\help.js`\nSelf documentation module\n5) `utility\\reload.js`\nCommand hot reloader module\n\n## Links\n\n- [Documentation](https://github.com/hack-chat/hackchat-server)\n- [GitHub](https://github.com/hack-chat/hackchat-server)\n- [NPM](https://www.npmjs.com/package/hackchat-server)\n- [Contributors](https://github.com/hack-chat/main/graphs/contributors) :heart:\n- [Legacy Contributors](https://github.com/AndrewBelt/hack.chat/graphs/contributors) :heart:\n\n## Languages\n\nCurrently supported:\n\n- English (en): [src/translations/en.json](src/translations/en.json)\n\n## Contributing\n\n**Languages:**\n\nAfter forking \u0026 cloning this repo, navigate to the [src/translations](src/translations) directory. Duplicate the `en.json` file. What you name the duplicate json file is fairly important, highly suggest that you use the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) abbreviations. The new language file will then be used by the `lang` property passed to the server, or by the `--lang` argument on the npx scripts.\n\n**Issues:**\n\nBefore creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the [documentation](https://github.com/hack-chat/hackchat-server).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhack-chat%2Fhackchat-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhack-chat%2Fhackchat-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhack-chat%2Fhackchat-server/lists"}