{"id":21623479,"url":"https://github.com/dylanfoster/hotcakes","last_synced_at":"2026-05-19T04:13:10.708Z","repository":{"id":57266815,"uuid":"42012105","full_name":"dylanfoster/hotcakes","owner":"dylanfoster","description":"RESTful api framework built on restify","archived":false,"fork":false,"pushed_at":"2016-03-18T02:08:31.000Z","size":179,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-04-24T09:11:05.658Z","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/dylanfoster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-06T17:49:02.000Z","updated_at":"2016-03-18T02:08:31.000Z","dependencies_parsed_at":"2022-08-25T03:41:16.432Z","dependency_job_id":null,"html_url":"https://github.com/dylanfoster/hotcakes","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/dylanfoster/hotcakes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dylanfoster%2Fhotcakes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dylanfoster%2Fhotcakes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dylanfoster%2Fhotcakes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dylanfoster%2Fhotcakes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dylanfoster","download_url":"https://codeload.github.com/dylanfoster/hotcakes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dylanfoster%2Fhotcakes/sbom","scorecard":{"id":362125,"data":{"date":"2025-08-11","repo":{"name":"github.com/dylanfoster/hotcakes","commit":"2ea8733ab52ec2daa0ad3092e663d409d6a5b5ad"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T11:05:39.514Z","repository_id":57266815,"created_at":"2025-08-18T11:05:39.514Z","updated_at":"2025-08-18T11:05:39.514Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33201543,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"online","status_checked_at":"2026-05-19T02:00:06.763Z","response_time":58,"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-11-25T00:13:06.692Z","updated_at":"2026-05-19T04:13:10.688Z","avatar_url":"https://github.com/dylanfoster.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hotcakes\n\n[![NPM](https://nodei.co/npm/hotcakes.png)](https://nodei.co/npm/hotcakes/)\n\n[![Build Status](https://travis-ci.org/dylanfoster/hotcakes.svg?branch=master)](https://travis-ci.org/dylanfoster/hotcakes) [![npm version](https://badge.fury.io/js/hotcakes.svg)](http://badge.fury.io/js/hotcakes)\n\n![](/hotcakes.png)\n\nhotcakes is a RESTful framework built with configuration in mind. It uses\n[restify](http://mcavage.me/node-restify/) under the hood for routing and makes\nbuilding your REST api quick and easy.\n\n## Installtion\n\n```shell\nnpm install --save hotcakes\n```\n\n## Usage\n\nhotcakes by default looks for your controllers in `\u003ccwd\u003e/controllers`, however,\nthis can be overidden in the hotcake constructor. An example structure might\nlook like this\n\n```shell\n|- lib/\n  |_ controllers/\n  |_ models/\n  |_ app.js\n|- index.js\n```\n\napp.js\n\n```javascript\nimport Stack from \"hotcakes\";\n\n// pass in restify options OR your own restify app instance\n\nlet hotcake = new Stack({\n  app: restify.createServer(),\n  restify: {\n    .. restify options ..\n  }\n});\n\nexport default hotcake;\n```\n\nindex.js\n\n```javascript\n\nimport app from \"./lib/app\";\n\n// initialize your api and start listening. Listens on 3800 by default\napp.boot();\n```\n\n## Controllers\n\nControllers handle actions. Controllers should be defined by their route\ncounterpart and the controller files should be in PascalCase e.g. `UserContoller.js`\nControllers' actions map to HTTP methods, with the exception of a route defined\nas a sub resource (e.g. `/users/:id` which will map to a `findById` controller\naction. If an HTTP method is not defined for one of your controllers, hotcakes\nwill return a `MethodNotAllowed` error. An example controller\n\nUserController.js\n\n```javascript\nexport default {\n  get: function (req, res, next) {\n    db.findAll().then(function (user) {\n      res.send(200, user);\n    });\n  },\n  findById: function (req, res, next) {\n    // the default paramKey is \"id\"\n    db.findById(req.params.id).then(function (user) {\n      res.send(200, user);\n    });\n  },\n  post: function (req, res, next) {\n    db.create(req.body).then(\n  }\n};\n```\n\n## Routes\n\nRoutes are the api. Routes define where requests should go and what to do with\nthem. Defining routes with hotcakes is super simple.\n\napp.js\n\n```javascript\nimport Stack from \"hotcakes\";\n\nlet hotcake = new Stack();\nlet Router = hotcake.Router;\n\nRouter.map(function () {\n  this.resource(\"users\");\n\n  // define a path otherwise the path will be implied\n\n  this.resource(\"users\", { path: \"/people\" });\n\n\n  // define a paramKey or use the default \"id\"\n\n  this.resource(\"users\", { paramKey: \"user_id\" });\n});\n\nexport default hotcake;\n```\n\nThe above will generate the following routes automatically, using user defined\ncontrollers for each action (e.g `GET /users` calls `UserController#get`)\n\n```shell\nGET /users        -\u003e UserController.get\nGET /users/:id    -\u003e UserController.findById\nPUT /users/:id    -\u003e UserController.put\nPOST /users       -\u003e UserController.post\nDELETE /users/:id -\u003e UserController.delete\n```\n\n#### `Hotcakes(options)`\n\nHotcake constructor\n\n**options**\n\n - `app`: restify app instance (optional)\n - `controllersPath`: path to controllers directory (optional) **Default**: `./controllers`\n - `port`: port for app to listen on. **Default**: `3800`\n - `restify`: options to pass to built in restify app\n\n#### `boot()`\n\ninitializes app and starts listening.\n\n#### `Router(options)`\n\nBuilds routes and maps them to controllers. Typically accessed through `hotcakes.Router`. `options` are the same as `Hotcakes`\n\n#### `map(callback)`\n\nMaps resources to a set of routes.\n\n```javascript\nRouter.map(function () {\n  this.resource(\"users\");\n});\n```\n\n## Contributing\n\nPull Requests and issues welcome! See [contributing](/CONTRIBUTING.md)\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Dylan Foster \u003cdylan947@gmail.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in the\nSoftware without restriction, including without limitation the rights to use, copy,\nmodify, merge, publish, distribute, sublicense, and/or sell copies of the Software,\nand to permit persons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\nINCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A\nPARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdylanfoster%2Fhotcakes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdylanfoster%2Fhotcakes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdylanfoster%2Fhotcakes/lists"}