https://github.com/edm00se/vue-parcel-starter

a simple vue.js starter with parcel
https://github.com/edm00se/vue-parcel-starter

jest parcel parcel-bundler parceljs prettier vuejs

Last synced: 7 days ago
JSON representation

a simple vue.js starter with parcel

• Host: GitHub
• URL: https://github.com/edm00se/vue-parcel-starter
• Owner: edm00se
• Created: 2018-09-18T17:16:23.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T14:36:57.000Z (5 months ago)
• Last Synced: 2024-06-20T01:28:02.915Z (5 months ago)
• Topics: jest, parcel, parcel-bundler, parceljs, prettier, vuejs
• Language: JavaScript
• Homepage: https://edm00se.codes/vue-parcel-starter/
• Size: 12.5 MB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        

vue-parcel-starter

  

    

  

  

    

  


This is a simple starter file for [vue.js 3][vue] with [parcel v2][parcel]. I love both vue.js and parcel, so having a base starter to use just makes sense.

Alternatively, you can just load up this starter at [its corresponding codesandbox url][codesandbox-link]:

https://codesandbox.io/s/github/edm00se/vue-parcel-starter

## Features

- [vue.js](https://npm.im/vue) with SFCs (single file components)

- [parcel](https://npm.im/parcel-bundler) for bundling and dev server

- [jest](https://npm.im/jest) for unit tests

- [vs code jest config](.vscode/launch.json) for debugging with tests

- [prettier](https://npm.im/prettier) for formatting

- [travis ci config](.travis.yml) for deploy via [GitHub Pages](https://pages.github.com/)

## Installation

- `npx degit edm00se/vue-parcel-starter my-app`

- `cd my-app`

- `npm install`

### GitHub Template

This repository is hosted on GitHub, in which it is marked as a "template". Clicking the big green "Use this template" button from [this repo's homepage](https://github.com/edm00se/vue-parcel-starter).

## Usage

- `npm run dev` gives you a development server with hot reloading

- `npm run build` creates a production ready build

- `npm test` runs test suites

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request 🙂

## History

This is based heavily upon the example of parcel with vue.js from the [parcel examples repo][parcel-examples]. This will grow over time to build out inclusion of some features unique from the source example.

## Unique Features (So Far)

- sass/scss support

- testing via [jest][jest]

## Related

- [edm00se/create-vue-parcel][npm-init] an npm initializer

## Credits

- [parcel][parcel]

- [vue.js][vue]

- [parcel-bundler/examples/Vue][parcel-examples-vue], upon which this is based

## License

MIT

[vue]: https://vuejs.org/

[parcel]: https://parceljs.org/

[parcel-examples]: https://github.com/parcel-bundler/examples

[parcel-examples-vue]: https://github.com/parcel-bundler/examples/tree/master/vue

[jest]: https://jestjs.io/

[codesandbox-link]: https://codesandbox.io/s/github/edm00se/vue-parcel-starter

[npm-init]: https://github.com/edm00se/create-vue-parcel