https://github.com/lennetech/nuxt-zeus
Nuxt 3 module for graphql zeus
https://github.com/lennetech/nuxt-zeus
Last synced: 5 months ago
JSON representation
Nuxt 3 module for graphql zeus
- Host: GitHub
- URL: https://github.com/lennetech/nuxt-zeus
- Owner: lenneTech
- Created: 2023-05-04T10:51:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-22T21:18:31.000Z (about 3 years ago)
- Last Synced: 2025-02-04T09:37:55.438Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 971 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# nuxt-zeus
[![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]
- [✨ Release Notes](/CHANGELOG.md)
Nuxt 3 module for https://github.com/graphql-editor/graphql-zeus 🚀
## Features
- 🚀 Use zeus in nuxt app
- 🚀 Some helper functions for better usage
- 🚀 Completely typed
## Quick Setup
1. Add `nuxt-zeus` dependency to your project
```bash
# Using pnpm
pnpm add -D nuxt-zeus
# Using yarn
yarn add --dev nuxt-zeus
# Using npm
npm install --save-dev nuxt-zeus
```
2. Add `nuxt-zeus` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'nuxt-zeus'
]
})
```
That's it! You can now use nuxt-zeus 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-zeus/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-zeus
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-zeus.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-zeus
[license-src]: https://img.shields.io/npm/l/nuxt-zeus.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-zeus
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com