{"id":23081287,"url":"https://github.com/lagden/boilerplate-ws","last_synced_at":"2025-08-15T23:31:20.315Z","repository":{"id":139377827,"uuid":"489453882","full_name":"lagden/boilerplate-ws","owner":"lagden","description":"Boilerplate para desenvolvimento de Websocket.","archived":false,"fork":false,"pushed_at":"2024-04-11T13:37:38.000Z","size":15,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T00:41:18.288Z","etag":null,"topics":["boilerplate","nodejs","uwebsockets","websocket"],"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/lagden.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":"2022-05-06T18:19:11.000Z","updated_at":"2023-11-28T20:56:18.000Z","dependencies_parsed_at":"2023-11-17T21:29:12.682Z","dependency_job_id":"abac2ccc-d4dd-43c0-8e98-f521ba85108e","html_url":"https://github.com/lagden/boilerplate-ws","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lagden/boilerplate-ws","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lagden%2Fboilerplate-ws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lagden%2Fboilerplate-ws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lagden%2Fboilerplate-ws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lagden%2Fboilerplate-ws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lagden","download_url":"https://codeload.github.com/lagden/boilerplate-ws/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lagden%2Fboilerplate-ws/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270644764,"owners_count":24621332,"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","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["boilerplate","nodejs","uwebsockets","websocket"],"created_at":"2024-12-16T13:51:11.560Z","updated_at":"2025-08-15T23:31:20.034Z","avatar_url":"https://github.com/lagden.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate Websocket Server\n\n[![Build Status][ci-img]][ci] [![Coverage Status][coveralls-img]][coveralls]\n\n[ci-img]: https://github.com/lagden/boilerplate-ws/actions/workflows/nodejs.yml/badge.svg\n[ci]: https://github.com/lagden/boilerplate-ws/actions/workflows/nodejs.yml\n[coveralls-img]: https://coveralls.io/repos/github/lagden/boilerplate-ws/badge.svg?branch=main\n[coveralls]: https://coveralls.io/github/lagden/boilerplate-ws?branch=main\n\nBoilerplate para desenvolvimento de uma aplicação.\n\n- [Instalação](#instalação)\n- [Como utilizar](#como-utilizar)\n  - [watch](#watch)\n  - [teste](#teste)\n- [Imagem](#imagem)\n- [Deploy](#deploy)\n- [Exemplo](#exemplo)\n- [Middlewares](#middlewares)\n- [License](#license)\n\n## Instalação\n\nUtilize `@tadashi/boilerplate-create` para iniciar o projeto.\n\n```\nnpm i -g @tadashi/boilerplate-create\nboilerplate-create\n```\n\nou\n\n```\nnpx --yes @tadashi/boilerplate-create\n```\n\nE siga as instruções do prompt.\n\n## Como utilizar\n\nApós finalizado o `scaffolding` do projeto, instale os pacotes.\n\n```shell\nbin/node/pkg.js\nbin/node/zera\n```\n\nFeito isso, o projeto está pronto para funcionar.\n\nPara rodar **local**, utilize:\n\n```shell\nbin/local/start\n```\n\nE via **docker**, utilize:\n\n```shell\nbin/docker/start\n```\n\n\u003e [!IMPORTANT]  \n\u003e No **docker**, caso seja instalado um novo pacote, é necessário fazer o `build` da imagem novamente.\n\nPare o container (`bin/docker/stop` ou `control + c`) e rode novamente passando o parâmetro `-b`:\n\n```shell\nbin/docker/start -b\n```\n\n### watch\n\nO **watch** reinicia a aplicação caso ocorra alguma alteração.  \nRodando via **docker** isso ocorre por padrão, mas **local** é necessário fazer algumas instalações e configurações.\n\n```shell\nbin/local/start -w\n```\n\n### teste\n\nPara executar os testes.\n\n**local:**\n\n```shell\nbin/local/test\n```\n\n**docker:**\n\n```shell\nbin/docker/test\n```\n\n## Imagem\n\nCrie os arquivos de usuário e senha do **registry** que serão utilizados para fazer o `push` da imagem.\n\n```shell\necho 'username' \u003e .registry-user\necho 'password' \u003e .registry-passwd\n```\n\nVerifique as suas variáveis de ambiente `.env-*`.  \nE para fazer o `push` da imagem de sua aplicação, execute:\n\n```shell\nbin/docker/image -e production\n```\n\n## Deploy\n\nPara executar o **deploy** é necessário alguns binários instalados:\n\n- **envsubst** by Bruno Haible\n- **rsync** by Andrew Tridgell, Wayne Davison and others\n\nO fluxo do sistema de **deploy** é simples:\n\n1. Carrega as variáveis de ambiente (`staging` ou `production`)\n2. Executa o script `bin/docker/image` (se passado o parâmetro `-i` esse processo é ignorado)\n3. Cria o arquivo `docker-compose-{VERSION}.yml` utilizando o **envsubst**\n4. Envia os arquivos para o servidor via **rsync**\n5. Executa o `docker stack deploy` no servidor\n\n```shell\nbin/docker/deploy -e production\n```\n\n## Exemplo\n\nUtilize o [wscat](https://www.npmjs.com/package/wscat).\n\n```shell\nnpm i -g wscat\n```\n\nAbra um shell e execute:\n\n```\nwscat -c 'ws://[::1]:5001/?access_token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiaWQiOiI2MjcxYmFiNWY2N2U5Y2NkNDkwMzNhYmIifQ.hmoUE_vayFKMKGz0v9iPLfIuneklDkL_qnD2n5QVKrYXmUwUqoJlSKGgafXIQGlyFxNZTucE8z8qdSRHZ-IXRQ'\nConnected (press CTRL+C to quit)\n\u003e {\"action\": \"direct\", \"message\": \"Olá\", \"to\": \"6271bab5f67e9ccd49033abc\"}\n\u003e {\"action\": \"me\", \"message\": \"Espelho, espelho meu!!\"}\n\u003e {\"action\": \"broadcast\", \"message\": \"Olá pessoal!\"}\n```\n\nEm outro shell:\n\n```\nwscat -c 'ws://[::1]:5001/?access_token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFsYmVydG8gUm9iZXJ0byIsImFkbWluIjp0cnVlLCJpYXQiOjE1MTYyMzkwMjIsImlkIjoiNjI3MWJhYjVmNjdlOWNjZDQ5MDMzYWJjIn0.CEoDPZn3IRrP4Cob6V_C41FxiqZoNkI6maN6c9tvfMrzw8gB5WWxBSiGdUWJ9HF4drPJANgEvfHKL8C0gNeuxA'\nConnected (press CTRL+C to quit)\n\u003c {\"action\": \"direct\", \"message\": \"Bãooo?\", \"to\": \"6271bab5f67e9ccd49033abb\"}\n\u003e {\"action\": \"broadcast\", \"message\": \"ihhhhulll!!!\"}\n```\n\n## Buy me a coffee\n\nBTC: bc1q7famhuj5f25n6qvlm3sssnymk2qpxrfwpyq7g4\n\n## License\n\nMIT © [Thiago Lagden](https://github.com/lagden)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flagden%2Fboilerplate-ws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flagden%2Fboilerplate-ws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flagden%2Fboilerplate-ws/lists"}