{"id":15366386,"url":"https://github.com/jasonboy/node-web-kit","last_synced_at":"2025-08-12T15:08:49.806Z","repository":{"id":143899697,"uuid":"49121796","full_name":"JasonBoy/node-web-kit","owner":"JasonBoy","description":"😎Node web starter kit for quick development, also Production Ready","archived":false,"fork":false,"pushed_at":"2018-10-26T04:11:02.000Z","size":256,"stargazers_count":7,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T13:17:22.188Z","etag":null,"topics":["boilerplate","express","node","starter-kit","web"],"latest_commit_sha":null,"homepage":"","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/JasonBoy.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-06T08:03:44.000Z","updated_at":"2023-03-04T06:05:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"39f539e8-0d46-4f1d-a0c1-ea0c2d1a3bd0","html_url":"https://github.com/JasonBoy/node-web-kit","commit_stats":{"total_commits":83,"total_committers":2,"mean_commits":41.5,"dds":"0.012048192771084376","last_synced_commit":"61ddb4b10af56207ca04b3e691183ae0625b7c73"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonBoy%2Fnode-web-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonBoy%2Fnode-web-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonBoy%2Fnode-web-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonBoy%2Fnode-web-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JasonBoy","download_url":"https://codeload.github.com/JasonBoy/node-web-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248571840,"owners_count":21126522,"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":["boilerplate","express","node","starter-kit","web"],"created_at":"2024-10-01T13:18:38.877Z","updated_at":"2025-04-15T12:21:30.427Z","avatar_url":"https://github.com/JasonBoy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-web-kit\n\n[![Building Status](https://travis-ci.org/JasonBoy/node-web-kit.svg?branch=master)](https://travis-ci.org/JasonBoy/node-web-kit) [![Dependency Status](https://david-dm.org/JasonBoy/node-web-kit.svg)](https://david-dm.org/JasonBoy/node-web-kit)\n\nNode web starter kit for quick development,\nwhich uses express as MVC,   \nand gulp as streaming build tool,  \nand less/sass for css, `css` task by default, which uses `scss`, change it to `less` for less files in related gulp files,  \nbrowserify to building js,\nalso supports proxy for your app's restful api    \n\n### Usage\n```\nnpm install node-web-kit //or clone the project\ncd ${path}/node-web-kit //go to the project root\nnpm install  \ngulp dev //using gulp directly, you may need to install gulp globally\n\n```\n\nother tasks: `gulp watch`, `gulp css`, `gulp js`, `gulp js.lib`, more in the `gulpfile.js` and `./gulp`\n\n`npm start` to start the server\n\n### Logs  \nThe logs will be put in `logs` folder\n\n### config.json.sample\n__[NOTICE]Add Multi API Endpoints support, `API_ENDPOINT` has changed to `API_ENDPOINTS`, and other related properties removed__  \nThis config file has couple configuration samples for your app,\nit will create create a `config.json` file while you using gulp or `npm start` automatically,\nor you can just copy that by yourself.  \nAll the config can also be set in your environment variable, which has higher priority.\n\n```javascript\n{\n  //server port  \n  \"NODE_PORT\": 3000,   \n  //Node env, also could be development/dev, production/prod, add more as you wish  \n  \"NODE_ENV\": \"development\",\n  //if you need to enable the api proxy  \n  \"NODE_PROXY\": true, \n  //`request` debug level,\n  //1: only use `request.debug = true`, 2: also add `request-debug`, default: no debug info.\n  \"PROXY_DEBUG_LEVEL\": 1, \n  \"STATIC_ENDPOINT\": \"\", //host for static assets, need other coding\n  \"API_ENDPOINTS\": {\n    \"/prefix\": \"http://localhost:3001\", //: /prefix/api1/login --\u003e http://localhost:3001/api1/login\n    \"/prefix2\": \"http://localhost:3002\"\n  }\n}\n\n```\n\n\n### Template Engines\n__Default template engine is [nunjucks](https://github.com/mozilla/nunjucks)__,   \nSince we are using the [consolidate.js](https://github.com/tj/consolidate.js), you can use any template engine you want.\n\n### Production Mode\n\n__Make sure you set the `NODE_ENV=production` or set `NODE_ENV` to `prod` or `production` in `config.json`__  \nAnd just run the `npm run prod ...` to simply start/reload the node server with PM2,  \n`npm run prod -- moduleName instanceNumber skipInstall`\ndefault moduleName is \"app\"  \n`npm run prod`, which will start/reload app in maximum instances(cpu cores), default instance name is `app`   \n`npm run prod -- app 2`, which will start/reload app with 2 instances enabled    \n`npm run prod -- app 0 1`, which will start app with maximum(0 == maximum) instances, but skip 'npm install'\nor\ncreate your own script if needed\n\n### License\n\nThe MIT License (MIT)\n\nCopyright (c) 2016 jason\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following 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\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjasonboy%2Fnode-web-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjasonboy%2Fnode-web-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjasonboy%2Fnode-web-kit/lists"}