{"id":22202151,"url":"https://github.com/rumkin/helicopter","last_synced_at":"2025-10-05T17:57:34.372Z","repository":{"id":57262393,"uuid":"43701042","full_name":"rumkin/helicopter","owner":"rumkin","description":"Modular network application framework","archived":false,"fork":false,"pushed_at":"2017-10-05T23:18:51.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-17T13:10:45.425Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/helicopter","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/rumkin.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","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":"2015-10-05T17:20:58.000Z","updated_at":"2017-10-05T23:18:53.000Z","dependencies_parsed_at":"2022-08-25T02:51:10.115Z","dependency_job_id":null,"html_url":"https://github.com/rumkin/helicopter","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/rumkin/helicopter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rumkin%2Fhelicopter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rumkin%2Fhelicopter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rumkin%2Fhelicopter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rumkin%2Fhelicopter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rumkin","download_url":"https://codeload.github.com/rumkin/helicopter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rumkin%2Fhelicopter/sbom","scorecard":{"id":789562,"data":{"date":"2025-08-18","repo":{"name":"github.com/rumkin/helicopter","commit":"5ac19ac56b93128d86e407fe4883896dfcf6340e"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T07:07:31.144Z","repository_id":57262393,"created_at":"2025-08-23T07:07:31.145Z","updated_at":"2025-08-23T07:07:31.145Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278494624,"owners_count":25996414,"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-10-05T02:00:06.059Z","response_time":54,"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":[],"created_at":"2024-12-02T16:12:34.690Z","updated_at":"2025-10-05T17:57:34.344Z","avatar_url":"https://github.com/rumkin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helicopter\n\nIs a web application framework inspired by SailsJS.\n\n## Install\n\nInstall helicopter via npm.\n\n```shell\nnpm install helicopter\n```\n\nTo have nice cli binary you can also install [helicpoter-cli](https://www.npmjs.com/package/helicopter-cli).\n```shell\nnpm install helicopter-cli -g\n```\n\n## Initialize project\n\nInitialize project with `init` command:\n\n```shell\nhelicopter init [dir]\n```\n\nThis command create new project with basic structure. To create project from\ntemplate use `create` command which will download template from github or npm:\n\n```shell\nhelicopter create helicopterjs/basic .\n```\n\n\n## Start server\n\nApplication should be started with `up` command:\n\n```shell\nhelicopter up [port]\n```\n\n### Options\n\n| Name        | Desc                      |\n|:------------|:--------------------------|\n| `v,verbose` | Make output verbose.      |\n| `e,env`     | Specify environment name. |\n| `d,debug`   | Turn debug mode on.       |\n\nRun application in development environment example.\n\n```shell\nhelicopter up -e development\n```\n\n## Run custom command\n\nHelicopter has cli interface to provide application's api which could be called\nfrom terminal:\n\n```shell\nhelicopter exec \u003ccommand\u003e -- [...args]\n```\n\nArguments are parsed automatically with simplified argv parser. It uses full name\narguments only like `--name[=value]`. Example:\n\n```shell\nhelicopter exec dump -- --mongo-db=test --dir=./test/ --overwrite\n```\n\n### Options\n\n| Name        | Desc                      |\n|:------------|:--------------------------|\n| `v,verbose` | Make output verbose.      |\n| `e,env`     | Specify environment name. |\n| `d,debug`   | Turn debug mode on.       |\n\n### Example\n\nCommands are specified with `commands` method of main app class stored in `app.js`.\nThis method should return dictionary of commands where key is a command name in\ncamel case and value is object descriptor of command. This method should\ncontains several keys: params, description and action.\n\n```javascript\nHelicopter.extend({\n  commands() {\n    return {\n      print: {\n        params: '[text]',\n        description: 'Print console arguments',\n        action: (text) =\u003e {\n          this.service('Print').print(text);\n        }\n      }\n    };\n  }\n});\n```\n\n## Filesystem layout\n\nDefault layout has 3 separated folders to separate code on levels `api`,\n`config` and `modules`. Basic example:\n\n```\n.\n|-- api\n|   |-- controllers\n|   |   `-- main-controller.js\n|   |-- events\n|   |   `-- main-events.js\n|   |-- models\n|   `-- services\n|   |   `-- print-service.js\n|-- config\n|   |-- app.js\n|   |-- development\n|   |   `-- app.js\n|   |-- events.js\n|   |-- http.js\n|   |-- production\n|   `-- routes.js\n|-- modules\n|-- app.js\n`-- package.json\n```\n\nBut you can choose your own layout system with overwriting core modules\nconfiguration.\n\n## Controllers\n\nUsually controllers stored in `api/controllers` directory in files with postfix\n`-controller.js`. Each controller file should export an object which methods\nwill be used as http methods. Routes could be configured manually in\n`config/routes.js` file and could differ for different environments.\n\nController example.\n\n```javascript\n// config/routes.js\nexports.routes = {\n  'GET /hello' : {\n    method: 'test.hello'\n  }\n};\n\n// api/controllers/test.js\nmodule.exports = {\n  hello(req, res) {\n    res.end('Hello world');\n  }\n};\n```\n\nController method also could be a generator thus it will be wrapped with [`co`](http://npmjs.org/packages/co).\nWeb controller could return promise and it's result will be used as http output.\nEach return result will be wrapped with customization [responses](#responces)\n(`sendData` and `sendError`).\n\n## Responses\n\nHTTP-interface supports custom response system to provide wide functionality.\nThere is two ways of using responses: manual in the code `res.notFound()` or\nautomatically by router which will run methods `res.sendError` if controllers\nmethod returns instance of error and `res.sendData` when method returns an\nobject.\n\nResponse file exports factory which returns new method. Example:\n\n```javascript\n// responses/not-found.js\nmodule.exports = function(req, res) {\n  return function (message) {\n    this.status(404)\n      .end(message || 'Nothing found');\n  };\n};\n```\n\n__NOTE__! Responses shares scope with whole `api` directory. See wide scope.\n\n## Wide scope\n\nHelicopter use it's own require mechanism which share scope of all files from\n`api` directory and allows to avoid mess of requires or other tricks with using\ninitialized modules. This way controllers could access to services by it's name.\n\nExample.\n\n```javascript\n// services/print-service.js\nmodule.exports = function () {\n  return {\n    print: function (msg) {\n      console.log(msg);\n    }\n  }\n};\n```\n\nUsing of print service in controller:\n```javascript\n// controllers/print-controller.js\nmodule.exports = {\n  print (req, res) {\n    PrintService.print(req.body);\n    res.end();\n  }\n};\n```\n\n## Misc\n\n[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rumkin/helicopter/trend.png)](https://bitdeli.com/free \"Bitdeli Badge\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frumkin%2Fhelicopter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frumkin%2Fhelicopter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frumkin%2Fhelicopter/lists"}