{"id":13495010,"url":"https://github.com/AllenFang/vue2-component-boilerplate","last_synced_at":"2025-03-28T15:32:36.953Z","repository":{"id":66230519,"uuid":"73593917","full_name":"AllenFang/vue2-component-boilerplate","owner":"AllenFang","description":"A simple and minimal boilerplate for creating a vue component","archived":false,"fork":false,"pushed_at":"2017-08-05T06:39:23.000Z","size":15,"stargazers_count":30,"open_issues_count":1,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-01T19:53:31.682Z","etag":null,"topics":["boilerplate","vue2","vue2-component"],"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/AllenFang.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-11-13T03:47:10.000Z","updated_at":"2023-08-23T12:58:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"0e21d9d8-b74d-40e9-bd10-5c9fae2ad41f","html_url":"https://github.com/AllenFang/vue2-component-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenFang%2Fvue2-component-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenFang%2Fvue2-component-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenFang%2Fvue2-component-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllenFang%2Fvue2-component-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AllenFang","download_url":"https://codeload.github.com/AllenFang/vue2-component-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222389519,"owners_count":16976487,"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","vue2","vue2-component"],"created_at":"2024-07-31T19:01:30.329Z","updated_at":"2024-10-31T09:31:43.686Z","avatar_url":"https://github.com/AllenFang.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# vue2-component-boilerplate\nIt's a boilerplate for that people who want to develop a vue2 component. This boilerplate inspired by [vuejs-templates/webpack](https://github.com/vuejs-templates/webpack), but it's\nmore simple and suitable for developing a vue2 component instead a vue application or a SPA.\n\n* Easy to use and understand, less configurations and template\n* Use ```webpack-dev-server``` for hot reload development\n* A minimal entry and html for preview the result on development\n* Only compitable for ```vue2.0```\n\nI saw some vue components on github which use boilerplate but there are a lots of configurations\nand files is useless, so hope this minimal boilerplate can help you to have a clean and simple enviorment for developing your component.\n\n## Getting Started\nFor using this boilerplate, you need to scaffold your repo by [vue-cli](https://github.com/vuejs/vue-cli)\n```sh\n$ vue init AllenFang/vue2-component-boilerplate YOUR_PROJECT_NAME\n$ cd YOUR_PROJECT_NAME\n$ npm install\n$ npm run dev\n```\n\n## What's Included\n* ```npm run dev``` : Development\n\t* Hot reload\n\t* ```webpack-dev-server``` as dev server\n\n* ```npm run build``` : Build for production\n\t* Javascript minified with [UglifyJS](https://github.com/mishoo/UglifyJS2)\n\t* Extract css(Default is false, but you can enable it)\n\t* The bundled js will be placed in ```dist``` folder\n\n* ```npm run unit``` : Unit test\n\n## Project Structure\n```sh\n├── build/                      # webpack configuration files\n│   └── ...\n├── src/\n│   ├── dev.js                  # the entry point for development\n│   ├── hello.vue               # just a sample vue component\n│   ├── index.js                # the entry point for production\n│   ├── main.vue                # the index for your components\n├── test/                       # unit tests\n│   ├── specs                   # testing spec\n│   │   └── ...                 # testing codes\n│   ├── .eslintrc               # eslint config for testing\n│   ├── index.js                # the entry for karam\n│   └── karma.conf.js           # karma config file\n├── .babelrc                    # babel config\n├── .editorconfig               # editor config\n├── .eslintrc.js                # eslint config\n├── .gitignore                  # git ignore config\n├── index.html                  # html used on webpack-dev-server\n└── package.json                # package.json\n└── README.md                   # README.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAllenFang%2Fvue2-component-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAllenFang%2Fvue2-component-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAllenFang%2Fvue2-component-boilerplate/lists"}