{"id":17671187,"url":"https://github.com/berkmann18/serverbuilder","last_synced_at":"2025-05-08T16:58:59.525Z","repository":{"id":38237997,"uuid":"119871926","full_name":"Berkmann18/ServerBuilder","owner":"Berkmann18","description":"Simple NodeJS/Express server builder","archived":false,"fork":false,"pushed_at":"2023-07-07T17:38:57.000Z","size":9198,"stargazers_count":0,"open_issues_count":18,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-08T16:58:28.855Z","etag":null,"topics":["builder","express","http","http2","https","nodejs","server","simple"],"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/Berkmann18.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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":{"github":"Berkmann18","patreon":"berkmann18"}},"created_at":"2018-02-01T17:50:43.000Z","updated_at":"2022-01-07T19:04:11.000Z","dependencies_parsed_at":"2024-10-24T05:24:43.767Z","dependency_job_id":"9369c66e-7cf5-4c9f-ab12-f2ffb7eb4b32","html_url":"https://github.com/Berkmann18/ServerBuilder","commit_stats":{"total_commits":755,"total_committers":8,"mean_commits":94.375,"dds":0.5443708609271523,"last_synced_commit":"f94c1ced5f1c2f04621cbac02bf26b8fd8dd7d3b"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Berkmann18%2FServerBuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Berkmann18%2FServerBuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Berkmann18%2FServerBuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Berkmann18%2FServerBuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Berkmann18","download_url":"https://codeload.github.com/Berkmann18/ServerBuilder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253112071,"owners_count":21856070,"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":["builder","express","http","http2","https","nodejs","server","simple"],"created_at":"2024-10-24T02:43:35.913Z","updated_at":"2025-05-08T16:58:59.497Z","avatar_url":"https://github.com/Berkmann18.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Berkmann18","https://patreon.com/berkmann18"],"categories":[],"sub_categories":[],"readme":"# ServerBuilder\n[![NPM](https://nodei.co/npm/serverbuilder.png)](https://nodei.co/npm/serverbuilder/)\n[![Inline docs](http://inch-ci.org/github/Berkmann18/ServerBuilder.svg?branch=master)](http://inch-ci.org/github/Berkmann18/ServerBuilder)\n\u003c!-- [![NSP Status](https://nodesecurity.io/orgs/berkmann18/projects/ea369eec-8c46-4ad6-903c-739aa66d006a/badge)](https://nodesecurity.io/orgs/berkmann18/projects/ea369eec-8c46-4ad6-903c-739aa66d006a) --\u003e\n\n[![devDependencies Status](https://david-dm.org/Berkmann18/ServerBuilder/dev-status.svg)](https://david-dm.org/Berkmann18/ServerBuilder?type=dev)\n[![dependencies Status](https://david-dm.org/Berkmann18/ServerBuilder/status.svg)](https://david-dm.org/Berkmann18/ServerBuilder)\n\n[![GH Downloads](https://img.shields.io/github/downloads/Berkmann18/ServerBuilder/total.svg)](https://github.com/Berkmann18/ServerBuilder/network/members)\n[![GitHub commit activity the past year](https://img.shields.io/github/commit-activity/y/Berkmann18/serverbuilder.svg)](https://github.com/Berkmann18/ServerBuilder/graphs/commit-activity)\n[![GitHub contributors](https://img.shields.io/github/contributors/Berkmann18/ServerBuilder.svg)](https://github.com/Berkmann18/ServerBuilder/graphs/contributors)\n[![Github search hit counter](https://img.shields.io/github/search/Berkmann18/ServerBuilder/goto.svg)](https://github.com/Berkmann18/ServerBuilder/graphs/traffic)\n\n[![Build Status](https://travis-ci.org/Berkmann18/ServerBuilder.svg?branch=master)](https://travis-ci.org/Berkmann18/ServerBuilder)\n[![codecov.io Code Coverage](https://img.shields.io/codecov/c/github/Berkmann18/ServerBuilder.svg?maxAge=2592000)](https://codecov.io/github/Berkmann18/ServerBuilder?branch=master)\n[![mocha](https://rawcdn.githack.com/aleen42/badges/11e00955d8be26223f0b89dddf49bc4a81e059ba/src/mocha.svg)](https://aleen42.github.io/badges/src/mocha.svg)\n[![Known Vulnerabilities](https://snyk.io/test/github/Berkmann18/ServerBuilder/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Berkmann18/ServerBuilder?targetFile=package.json)\n\n[![GitHub](https://img.shields.io/github/license/Berkmann18/ServerBuilder.svg)](https://github.com/Berkmann18/ServerBuilder/blob/master/LICENSE)\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/Berkmann18/ServerBuilder/issues)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\u0026identifier=115825259)](https://dependabot.com)\n\n[![GitHub top language](https://img.shields.io/github/languages/top/Berkmann18/ServerBuilder.svg)](https://github.com/Berkmann18/ServerBuilder)\n[![GitHub language count](https://img.shields.io/github/languages/count/Berkmann18/ServerBuilder.svg)](https://github.com/Berkmann18/ServerBuilder)\n[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Berkmann18/ServerBuilder.svg)](https://github.com/Berkmann18/ServerBuilder)\n\n\n[![BCH compliance](https://bettercodehub.com/edge/badge/Berkmann18/ServerBuilder?branch=master)](https://bettercodehub.com/results/Berkmann18/ServerBuilder)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/40e42558e9ad4f54a014f063aa48817c)](https://www.codacy.com/app/maxieberkmann/ServerBuilder?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=Berkmann18/ServerBuilder\u0026amp;utm_campaign=Badge_Grade)\n\nIt's a simple NodeJS/Express server builder allowing you to get a working server up in just a few lines.\n\n## Install\nTo install it you need to run the following:\n```cli\nnpm i serverbuilder\n```\n\n_Note_: Don't forget to use `-g`, `--save`, `--save-dev` if appropriate.\n\n## Usage\n-   Using **HTTP/1**:\n```js\nconst app = require('express')(),\n      Server = require('serverbuilder');\nconst options = {\n  name: 'My Server',\n  publicIP: true\n};\n\nconst server = new Server(app, process.env.PORT || 3e3, options);\nserver\n  .run()\n  .then(serv =\u003e app.set('port', serv.port), console.error);\n```\n-   Or with **HTTPS/1**:\n```js\nconst fs = require('fs'),\n      app = require('express')(),\n      Server = require('serverbuilder');\n\nconst options = {\n  name: 'My Server',\n  useHttps: true,\n  securityOptions: {\n    key: fs.readFileSync('server-key.pem'),\n    cert: fs.readFileSync('server-cert.pem')\n  },\n  publicIP: true\n};\n\nconst server = new Server(app, process.env.PORT || 3e3, options);\nserver\n  .run()\n  .then(serv =\u003e app.set('port', serv.port), console.error);\n```\n\n-   Or with **HTTP/2**:\n```js\nconst fs = require('fs'),\n      app = require('express')(),\n      Server = require('serverbuilder');\n\nconst options = {\n  name: 'My Server',\n  useHttp2: true,\n  securityOptions: {\n    key: fs.readFileSync('server-key.pem'),\n    cert: fs.readFileSync('server-cert.pem')\n  },\n  publicIP: true\n};\n\nconst server = new Server(app, process.env.PORT || 3e3, options);\nserver\n  .run()\n  .then(serv =\u003e app.set('port', serv.port), console.error);\n```\n\n## Contribution\nIf you discover bugs, errors or/and have suggestions/feedback please create an [issue](http://github.com/Berkmann18/ServerBuilder/issues) or/and submit a [PR](http://github.com/Berkmann18/ServerBuilder/pulls).\n\nIf you want to contribute, make sure you stick with the coding style that ESLint is enforcing (cf. configuration file).\nTo check if a file stick to the standards:\n```cli\neslint -c ./config/.eslintrc.js yourFile.js\n#Or `npm lint` if appropriate\n```\nTo fix formatting errors and such, run:\nSame as above but with `--fix` at the end.\nFore more details, please check [the contribution guideline](./github/CONTRIBUTING.md).\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://maxcubing.wordpress.com\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/8260834?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMaximilian Berkmann\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Berkmann18/ServerBuilder/issues?q=author%3ABerkmann18\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/Berkmann18/ServerBuilder/commits?author=Berkmann18\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/Berkmann18/ServerBuilder/commits?author=Berkmann18\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-Berkmann18\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#question-Berkmann18\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e \u003ca href=\"https://github.com/Berkmann18/ServerBuilder/pulls?q=is%3Apr+reviewed-by%3ABerkmann18\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#security-Berkmann18\" title=\"Security\"\u003e🛡️\u003c/a\u003e \u003ca href=\"https://github.com/Berkmann18/ServerBuilder/commits?author=Berkmann18\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://dependabot.com\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/36207117?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDependabot\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#tool-dependabot-bot\" title=\"Tools\"\u003e🔧\u003c/a\u003e \u003ca href=\"#security-dependabot-bot\" title=\"Security\"\u003e🛡️\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://semantic-release.org/\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/32174276?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSemantic Release Bot\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Berkmann18/ServerBuilder/commits?author=semantic-release-bot\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#platform-semantic-release-bot\" title=\"Packaging/porting to new platform\"\u003e📦\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://snyk.io\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/19733683?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSnyk bot\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#security-snyk-bot\" title=\"Security\"\u003e🛡️\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberkmann18%2Fserverbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fberkmann18%2Fserverbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberkmann18%2Fserverbuilder/lists"}