https://github.com/rogeriotaques/vue-start-kit
A boring boilerplate for Vue 2 applications, by Rogerio Taques.
https://github.com/rogeriotaques/vue-start-kit
boilerplate eslint jest pinia sass typescript vue vue-router vuejs webpack
Last synced: 4 months ago
JSON representation
A boring boilerplate for Vue 2 applications, by Rogerio Taques.
- Host: GitHub
- URL: https://github.com/rogeriotaques/vue-start-kit
- Owner: rogeriotaques
- License: other
- Created: 2019-01-29T16:53:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-09-16T09:42:07.000Z (10 months ago)
- Last Synced: 2025-10-19T00:41:53.953Z (8 months ago)
- Topics: boilerplate, eslint, jest, pinia, sass, typescript, vue, vue-router, vuejs, webpack
- Language: Vue
- Homepage:
- Size: 2.73 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.md
Awesome Lists containing this project
README
# Vue Start Kit
A boring boilerplate for Vue 2 applications, by Rogerio Taques.
## What is included?
- [Vue 2](https://v2.vuejs.org/) (with composition api)
- [Vue-Router](https://router.vuejs.org/)
- [Pinia](https://pinia.esm.dev/)
- [Axios](https://axios-http.com/)
- [Sass](https://sass-lang.com/)
- [Webpack](https://webpack.js.org/) (with hot module replacement)
- [EditorConfig](https://editorconfig.org/)
- [Prettier](https://prettier.io/)
- [TypeScript](https://www.typescriptlang.org/)
- [Jest](https://jestjs.io/)
## Why shuuld you use this?
You probably should not. Vue is already on v3 and this is based on v2.
But, you may find this useful if, for some reason, you want to quickly bootstrap a Vue 2 application. It comes with all the bare minium to code a SPA.
Here's what you get in this bundle 👇
- 🚀 Quick to start coding your app
- 🙌 Very clean and intuitive file structure
- 🔥 Live programming environment (with Hot Module Replacement)
- 🎯 Linter and Vue Coding Guidelines up an running
- 💪 Pre configured unit tests
- ✅ Well commented and easy to understand source-code
- 💡 A sample (ToDo 🤷🏻♂️) app
## Get started
```sh
# 1. clone it
$ git clone https://github.com/rogeriotaques/vue-start-kit.git [YOUR-AWESOME-APP-NAME]
# 2. install all the dependencies
$ yarn # or npm install
# 3. start the (live) development environment
$ yarn start # or npm start
```
👉🏻 Don't forget to change `[YOUR-AWESOME-APP-NAME]` with the name you wanna give to your new app.
👉🏻 A new tab will open on your (default) browser pointing to [http://localhost:1234/](http://localhost:1234/). If this address is already in use, it will automatically choose another random port.
Hooray! 🎉 At this point you should be seeing the app running already.
From now on, everything you change in the `source-code` will trigger an immediate update on the browser (_without refresh_) preserving the current state of your newly created app.
## Building for production
Once your app is ready to be distributed, run:
```sh
$ yarn build # or npm run build
```
This will create the `dist/` directory with all the compiled files from your app, ready to be deployed to your servers. 🚀
## Contributing
Contributions are _very_ welcome and are expected to be made via [pull requests](https://github.com/AbtzLabs/vue-start-kit/pulls). As for now, I don't have any contribution guidelines in place, so, please don't be evil. 😉
You can simply start by:
1. Forking this repository;
2. Changing and implementing what you think necessary;
4. Submitting a pull-request.
There are a few more ways for you to contribute to this project:
- Be my reviewer. Check my code and suggest improvements
- Be my sponsor with a single contribution of [$2.50](https://paypal.me/abtzlabs/2.5USD), [$5](https://paypal.me/abtzlabs/5USD) or [$10](https://paypal.me/abtzlabs/10USD) (via Paypal)
- Be my boss 😬, with a monthly [sponsorship](https://github.com/sponsors/rogeriotaques) (via Github)
## Unit tests
The unit tests are written in `Jest` and they can be found in `src/__test__`.
Run the following command to start the tests:
```sh
$ yarn unit # or npm run unit
```
## Found a 🐞 (bug)?
Shame on me! 😊 But you know, that may happen!
- [Open an Issue](https://github.com/rogeriotaques/vue-start-kit/issues) and I'll take care of it
- Or you can fix it and [submit a pull request](https://github.com/rogeriotaques/vue-start-kit/pulls) 🙇♂️
## License
Vue Start Kit - MIT License
Copyright © 2019-2023 Rogerio Taques.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## Where this has been used?
I have been using this as the start point for all my side-projects, e.g: 👇
| Name | URL | Description | Status |
| ---- | ---- | ----------- | ------ |
| 3o2 | [https://3o2.co](https://3o2.co) | The headless URL shortener. | Descontinued |
| 
| [https://mailshld.com](https://mailshld.com) | Dynamic and replaceable aliases for Gmail | Sold |
Are you also using it and want some free advertisement? 😬 [Get in touch](https://twitter.com/rogeriotaques) and I will add your logo here with a back-link to your product or website.