Skip to content

Commit 14a34b8

Browse files
committed
docs: Create README.md
1 parent dcc41ae commit 14a34b8

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Vue Frontend Quickstart
2+
> Starter template for a Vue site - without Node
3+
4+
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/vue-frontend-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/vue-frontend-quickstart/releases/)
5+
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
6+
7+
[![dependency - vue](https://img.shields.io/badge/dependency-vue-blue?logo=vue.js&logoColor=white)](https://www.npmjs.com/package/vue)
8+
[![Hosted with GH Pages](https://img.shields.io/badge/Hosted_with-GitHub_Pages-blue?logo=github&logoColor=white)](https://pages.github.com/)
9+
10+
11+
## Preview
12+
13+
<div align="center">
14+
<a href="https://michaelcurrin.github.io/vue-frontend-quickstart/">
15+
<img src="/sample.png" alt="Sample screenshot" title="Sample screenshot" width="400" />
16+
</a>
17+
</div>
18+
19+
20+
## Online demo
21+
22+
<div align="center">
23+
24+
[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-blue?style=for-the-badge)](https://michaelcurrin.github.io/vue-frontend-quickstart/)
25+
26+
</div>
27+
28+
29+
## Use this project
30+
31+
<div align="center">
32+
33+
[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/vue-frontend-quickstart/generate)
34+
35+
</div>
36+
37+
To extend the app and make it more interactive, see code samples in the [Getting Started](https://v3.vuejs.org/guide/introduction.html#getting-started) docs.
38+
39+
40+
## Features
41+
> About this template project
42+
43+
- Made with Vue 3.
44+
- Served as HTML and JS static assets.
45+
- Uses ESModules so you can use `import` syntax.
46+
- No build step needed.
47+
- No need for Node or Vue CLI.
48+
- No need for `package.json` or other JS configs.
49+
- Hosted with GitHub Pages for free.
50+
51+
52+
## What is Vue?
53+
54+
Vue is "The Progressive Frontend Framework".
55+
56+
It add can be interactivity to your website. Either as components on an existing site, or for designing your entire site as a Single-Page Application.
57+
58+
More readable and robust than jQuery. Vue is declarative so you don't have to worry about low-level operations like finding an element and changing its value.
59+
60+
Vue is similar to React, but many including myself believe that Vue is easier to learn and use.
61+
62+
See my [Resources](https://michaelcurrin.github.io/dev-resources/resources/javascript/packages/vue/) page to learn more about Vue.
63+
64+
65+
66+
## Developer notes
67+
68+
Browse builds available:
69+
70+
- https://unpkg.com/browse/vue@3.0.7/dist/
71+
72+
The `vue.esm-browser.js` build was selected - for ESModule load in the browser including a template compiler.
73+
74+
Using `vue.runtime.esm-browser.js` gave an error:
75+
76+
[Vue warn]: Component provided template option but runtime compilation is not supported in this build of Vue. Use "vue.esm-browser.js" instead.
77+
at <App> vue.runtime.esm-browser.js:1186:17
78+
79+
Also, I tried using JSPM for CDN but gave errors importing Vue - switching to unpkg with ESModule type was fine.
80+
81+
82+
## License
83+
84+
Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).

0 commit comments

Comments
 (0)