Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rmjordas/awesome-vue

🎉 A curated list of awesome things related to Vue.js
https://github.com/rmjordas/awesome-vue

List: awesome-vue

awesome awesome-list vue vuejs vuepress

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

        


Awesome Vue.js




Awesome Vue.js

A curated list of awesome things related to Vue.js



Deploy to GitHub Pages build status badge


Awesome Vue.js website


This project does not aim to replace the **[official Vue.js Awesome List][vuejs/awesome-vue]** but rather to provide a nicer experience when browsing the content.

[vuejs/awesome-vue]: https://github.com/vuejs/awesome-vue

## Instructions

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

```bash
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.

```bash
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`**.

```bash
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](.github/CONTRIBUTING.md).

## License

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

For more information, please refer to