MechJosh0 / awesome-vue

🎉 A curated list of awesome things related to Vue.js

Awesome Vue.js

A curated list of awesome things related to Vue.js

---

This project does not aim to replace the official Vue.js Awesome List but rather to provide a nicer experience when browsing the content.

Instructions

To run this application on your machine, first clone the repository and install the required dependencies:

git clone https://github.com/rmjordas/awesome-vue.git
cd awesome-vue
npm install

Run the dev script to compile the content and spawn a local server to serve the compiled code. While this script is running, any changes made to the markdown files will automatically be updated on the locally served pages.

npm run dev

To prepare the application for deployment, first run npm run build to compile the application in production mode. This will generate a directory in content/.vuepress called dist.

npm run build
# You can use `serve` to inspect the output
npm install -g serve
serve content/.vuepress/dist

Scripts

Script	Description
dev	Compiles content and serves bundled code
build	Compiles content and other static assets for deployment
lint	Runs markdown linter to check lint errors
test	An alias for lint (runs lint script)

Contributing

Please refer to the Contributing Guide.

License

This is free and unencumbered software released into the public domain.

For more information, please refer to https://unlicense.org