https://github.com/jonlabelle/vue-project-template
A Vue.js boilerplate project template.
https://github.com/jonlabelle/vue-project-template
boilerplate examples nodejs template vue
Last synced: 16 days ago
JSON representation
A Vue.js boilerplate project template.
- Host: GitHub
- URL: https://github.com/jonlabelle/vue-project-template
- Owner: jonlabelle
- License: mit
- Created: 2021-03-28T23:26:29.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-21T15:14:55.000Z (about 2 years ago)
- Last Synced: 2025-01-23T03:29:25.646Z (over 1 year ago)
- Topics: boilerplate, examples, nodejs, template, vue
- Language: Vue
- Homepage: https://vue-project-template.jonlabelle.com
- Size: 1.3 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue.js project template
[](https://github.com/jonlabelle/vue-project-template/actions/workflows/ci.yml)
[](https://github.com/jonlabelle/vue-project-template/actions/workflows/cd.yml)
[](https://github.com/jonlabelle/vue-project-template/actions/workflows/code-analysis.yml)
> A [Vue.js](https://vuejs.org) boilerplate project template.
## Demo
Checkout the built [static site] from this template.
## Usage
If deciding to use this [repository template] for your project, please be sure
to replace the following configuration items with your own.
**[package.json](package.json)**
```json
{
"name": "vue-project-template",
"description": "A Vue.js project (boilerplate) template.",
"version": "2.0.0",
"private": true,
"license": "MIT",
"author": "Jon LaBelle",
"repository": "jonlabelle/vue-project-template",
"bugs": {
"url": "https://github.com/jonlabelle/vue-project-template/issues"
},
"homepage": "https://github.com/jonlabelle/vue-project-template",
"keywords": ["vue", "project-template", "template"]
}
```
**[LICENSE](LICENSE)**
```text
Copyright (c) Jon LaBelle
```
**[CHANGELOG.md](CHANGELOG.md)**
```md
## 2.0.0
**Release date:** unreleased
### Enhancements
- ...
- ...
### Bug fixes
- ...
- ...
```
## Project Setup
```console
npm install
```
### Compile and Hot-Reload for Development
```console
npm run dev
```
### Compile and Minify for Production
```console
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```console
npm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```console
npm run lint
```
## Docker
To run the site in Docker:
1. Build the image: `npm run docker-build`
2. Start the container: `npm run docker`
3. Open your browser to:
[npm package]: https://www.npmjs.com/package/@vue/cli
[vue cli]: https://next.cli.vuejs.org/
[`vue create`]: https://next.cli.vuejs.org/guide/creating-a-project.html#vue-create
[`vue serve`]: https://next.cli.vuejs.org/guide/cli-service.html#vue-cli-service-serve
[repository template]: https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
[static site]: https://vue-project-template.jonlabelle.com