{"id":22903970,"url":"https://github.com/json2d/bunk","last_synced_at":"2025-04-01T07:56:51.329Z","repository":{"id":57191599,"uuid":"86476139","full_name":"json2d/bunk","owner":"json2d","description":"a decidedly featureless, low dependency http server to serve static resource files, with cli support","archived":false,"fork":false,"pushed_at":"2017-04-11T20:12:00.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T01:36:22.167Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/json2d.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}},"created_at":"2017-03-28T15:23:51.000Z","updated_at":"2017-03-28T15:24:11.000Z","dependencies_parsed_at":"2022-09-15T22:23:26.344Z","dependency_job_id":null,"html_url":"https://github.com/json2d/bunk","commit_stats":null,"previous_names":["bitstrider/bunk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json2d%2Fbunk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json2d%2Fbunk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json2d%2Fbunk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json2d%2Fbunk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/json2d","download_url":"https://codeload.github.com/json2d/bunk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246604619,"owners_count":20804100,"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-12-14T02:39:37.811Z","updated_at":"2025-04-01T07:56:51.307Z","avatar_url":"https://github.com/json2d.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bunk\n\na decidedly featureless, low dependency http server to serve static resource files, with cli support\n\n### Getting Started\nInstall it globally for use on the command line.\n```\n$ npm install -g bunk\n```\n\n### CLI Usage\nThe most basic way to use `bunk` is to run on the terminal:\n```\n$ bunk\n```\nThis will serve all static files within the current working directory at [localhost:7070](localhost:7070).\n\n### Options\nFor more _\"advanced\"_ usage, include in the command:\n```\n  -d, --dir \u003cdir\u003e    directory of static files to serve, default: .\n  -p, --port \u003cport\u003e  port to run http server on, default: 7070\n```\n\nFor exmaple, to serve the directory `build/production` on port `1337`, run on the terminal:\n```\n$ bunk -d build/production -p 1337\n```\n\nIt is recommended, but not required, that you have an `index.html` within the root of the directory being served.\n\n\n### API Usage\nInstall it as a local dependency for use within another module.\n```\n$ npm install --save bunk\n$ npm install --save-dev bunk\n```\n\nThen require and call `bunk` with or without options\n\n```javascript\nvar bunk = require('bunk');\n\nbunk()\n// =\u003e bunk: serving . on port 7070\n\nbunk({dir:'build/production', port:1337})\n// =\u003e bunk: serving build/production on port: 1337\n```\n\n### Credits\nThis module was heavily inspired by an example usage of [serve-static](https://github.com/expressjs/serve-static).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjson2d%2Fbunk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjson2d%2Fbunk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjson2d%2Fbunk/lists"}