{"id":14989642,"url":"https://github.com/jimzhan/prototype.js","last_synced_at":"2025-04-12T01:40:59.136Z","repository":{"id":57331851,"uuid":"78205096","full_name":"jimzhan/prototype.js","owner":"jimzhan","description":"Production application boilerplate for Vue.js \u0026 Koa.js","archived":false,"fork":false,"pushed_at":"2017-06-30T17:20:16.000Z","size":176,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T18:04:50.678Z","etag":null,"topics":["boilerplate","koajs","prototype","vuejs","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jimzhan.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-01-06T12:40:20.000Z","updated_at":"2018-01-21T21:12:01.000Z","dependencies_parsed_at":"2022-09-05T10:12:31.047Z","dependency_job_id":null,"html_url":"https://github.com/jimzhan/prototype.js","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fprototype.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fprototype.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fprototype.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimzhan%2Fprototype.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jimzhan","download_url":"https://codeload.github.com/jimzhan/prototype.js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505741,"owners_count":21115352,"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","koajs","prototype","vuejs","webpack"],"created_at":"2024-09-24T14:18:41.674Z","updated_at":"2025-04-12T01:40:59.114Z","avatar_url":"https://github.com/jimzhan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Vue.js :revolving_hearts: Koa.js\n================================\n[![dependencies](https://david-dm.org/jimzhan/prototype.js.svg)](https://david-dm.org/jimzhan/prototype.js.svg)\n[![build](https://travis-ci.org/jimzhan/prototype.js.svg?branch=master)](https://travis-ci.org/jimzhan/prototype.js)\n[![npm version](https://img.shields.io/npm/v/prototype.js.svg?style=flat-square)](https://www.npmjs.com/package/prototype.js)\n[![npm downloads](https://img.shields.io/npm/dm/prototype.js.svg?style=flat-square)](https://www.npmjs.com/package/prototype.js)\n\nProduction application boilerplate for Vue and Koa, batteries included:\n+ ES6 + Babel\n+ [ESLint](https://github.com/eslint/eslint) with the [Airbnb JavaScript](https://github.com/airbnb/javascript) rules.\n+ [Mocha](https://github.com/mochajs/mocha) Unit testing and coverage with [Chai](https://github.com/chaijs/chai) assertion framework.\n+ [Nightwatch](https://github.com/nightwatchjs/nightwatch) E2E UI automated testing framework.\n+ [Editorconfig](http://editorconfig.org/) Consistent coding styles formatter.\n+ [Yarn](https://yarnpkg.com/en/) Dependency management.\n+ [Vue.js](https://github.com/vuejs/vue) Progressive frontend framework.\n+ [Koa.js](https://github.com/koajs/koa) Next generation web framework.\n+ [Dotenv](https://github.com/motdotla/dotenv) Production settings profile solution.\n+ [Foundation](http://foundation.zurb.com/) Framework Integration with common UI components on Vue.\n+ NPM scripts for common operations.\n\n## Key NPM Scripts\n* `npm start` - start Koa and Webpack server simultaneously with hot reload supports in foreground (default port `3000`), all consequent requests prefixed by `/v1` will be proxied to Koa automatically.\n* `npm run start:staging` - compile front end source code using `etc/webpack.staging.js` into folder `dist` then start Koa server via `PM2` with static assets supports.\n* `npm run stop:staging` - stop Koa server via `PM2`. \n* `npm run start:release` - compile front end source code using `etc/webpack.release.js` into folder `dist` then start Koa server via `PM2`.\n* `npm run stop:release` - stop Koa server via `PM2`. \n\n## Client\n* webpack supports with `develop`, `staging` and `release` settings profiles.\n\n## Server\n* configurable prefixed server endpoint (`/v1` by default).\n* intelligent/automatic routes registration.\n\n  Module created under `apps` folder with routes defined in `index.js` will be registered onto server router automatically.\n```javscript\n// OPTIONAL prefix definition, by default, system will register the module name as its routing prefix.\n//  `prefix -\u003e false` will disable prefix for this module.\nexport const prefix = '/\u003cmodule-prefix\u003e';\n\nimport * as mw from './middleware';\nimport * as views from './views';\n\nexport default {\n  'GET /', views.list,\n  'GET /:key', views.get,\n  'POST /', [mw.acl, views.create],\n  'PUT  /:key', views.update,\n  'DELETE /:key', views.delete,\n}\n```\n\nTODOs\n=====\n- [x] ESLint rules supports.\n- [x] webpack/webpack-dev-server support.\n- [x] NPM scripts for common operations.\n- [x] multiple webpack settings profiles.\n- [x] `dotenv` based multi settings profiles at server side.\n- [x] Grouped routing system.\n- [x] unit test integration\n- [x] hot reload koa server\n- [ ] e2e test integration\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimzhan%2Fprototype.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimzhan%2Fprototype.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimzhan%2Fprototype.js/lists"}