https://github.com/zalweny26/nuxt-driverjs
https://github.com/zalweny26/nuxt-driverjs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zalweny26/nuxt-driverjs
- Owner: zAlweNy26
- Created: 2024-03-08T21:45:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-09T12:34:54.000Z (over 1 year ago)
- Last Synced: 2025-04-06T06:09:45.920Z (2 months ago)
- Language: TypeScript
- Size: 91.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Nuxt driver.js Module
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
Nuxt module for the [driver.js](https://driverjs.com) library.
- [✨ Release Notes](/CHANGELOG.md)
## Features
- Helps you integrate the driver.js library
- Provides the main $driver helper globally
- Zero-config setup ready to go
- TypeScript friendly
- Super easy to use
## Quick Setup
1. Add `nuxt-driverjs` dependency to your project
```bash
# Using pnpm
pnpm add -D nuxt-driverjs
# Using yarn
yarn add --dev nuxt-driverjs
# Using npm
npm install --save-dev nuxt-driverjs
```
2. Add `nuxt-driverjs` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'nuxt-driverjs'
]
})
```
That's it! You can now use Nuxt driver.js Module in your Nuxt app ✨
## Development
```bash
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release
```
[npm-version-src]: https://img.shields.io/npm/v/nuxt-driverjs/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-driverjs
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-driverjs.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/nuxt-driverjs
[license-src]: https://img.shields.io/npm/l/nuxt-driverjs.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-driverjs
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com