Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Tahul/vue-composable-starter
🪝 Minimalist starting point for your next Vue Composable
https://github.com/Tahul/vue-composable-starter
vue-composable vue-hook vue-starter
Last synced: 3 months ago
JSON representation
🪝 Minimalist starting point for your next Vue Composable
- Host: GitHub
- URL: https://github.com/Tahul/vue-composable-starter
- Owner: Tahul
- License: mit
- Created: 2021-01-02T00:46:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-14T06:18:32.000Z (about 2 years ago)
- Last Synced: 2024-05-01T14:54:12.856Z (6 months ago)
- Topics: vue-composable, vue-hook, vue-starter
- Language: TypeScript
- Homepage: https://yael.dev
- Size: 734 KB
- Stars: 53
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-vue-3 - vue-composable-starter - 🪝 Minimalist starting point for your next Vue composable. (Tools)
README
# 🪝 vue-composable-starter
A minimalist starting point for your next Vue 3 composable.
- 🧩 **TypeScript** by default
- 📦 **PNPM** as package manager
- 🤹 Testing using [**Vitest**](https://vitest.dev)
- ☑️ Linting using [**@antfu/eslint-config**](https://github.com/antfu/eslint-config)
- 🌐 [**Nuxt 3**](https://nuxtjs.org) as a playground
- 📸 Demo ready to be written and deployed using [**Vite**](https://vitejs.dev)
- 🚚 Built using [**unbuild**](https://github.com/unjs/unbuild)
> Edit [variables](#to-do), implement, test, publish 🏎
## Commands
Build the package:
```bash
pnpm build
```
Build with watcher:
```bash
pnpm dev
```
Run the demo:
```bash
pnpm dev:demo
```
Build the demo:
```bash
pnpm build:demo
```
Lint the package:
```bash
pnpm link
```
Run test suite:
```bash
pnpm test
```
Test typings:
```bash
pnpm test:types
```
Start Nuxt 3 env:
```bash
pnpm dev:nuxt
```
Build Nuxt 3 env:
```bash
pnpm build:nuxt
```
Preview Nuxt 3 env:
```bash
pnpm start:nuxt
```
## Why
This repository is useful if you want to start a new Vue composable, or a general Vue package.
I used it personally for:
- [**@vueuse/motion**](https://github.com/vueuse/motion)
- [**@vueuse/gesture**](https://github.com/vueuse/gesture)
- [**@vueuse/sound**](https://github.com/vueuse/sound)
I try to keep it updated when I upgrade my own workflow!
## Workflow
I usually develop with the `dev:nuxt` command.
Your changes on any file will be reloaded by **Nuxt**, and you can start trying SSR capabilities of your composable easily!
The general Nuxt environment does not differ from a classic Vue app.
## To-Do
- [ ] Edit package.json `name`, `description`, `repository` and `author` keys.
- [ ] Remove .vscode folder (containing recommended extensions)
- [ ] Edit README.md.
- [ ] Implement my composable.
- [ ] Test my composable.
- [ ] Make a demo of my composable in the `demo` folder.
- [ ] Document my composable.
- [ ] Publish on [NPM](npmjs.com), [awesome-vue](https://github.com/vuejs/awesome-vue), [vue-forum](https://forum.vuejs.org/), [Vue Discord](https://fr.vuejs.org/v2/guide/join.html).
## Contributing
You are more than welcome to improve this starter template.
Just submit your changes via pull request and I will review them before merging.
If you are making a fix on the template, you can use the `main` branch and send a pull request.
If you are adding a new features, please create a new branch with a name describing your feature (`my-new-feature`), push to your branch and then submit a pull request.