Skip to content

Nuxt Server Extension (NXSE): Database utils, Admin Panel and more (coming up)

License

Notifications You must be signed in to change notification settings

mukundshah/nxse

Repository files navigation

Nuxt Server Extension (NXSE)

🚧 Work in progress 🚧

Why NXSE? | Documentation | Release Notes

npm version npm downloads Nuxt

Features

  • Database utilities
  • REST API Utilities (coming soon)
  • Admin panel

Quick Setup

  1. Add nxse and @nuxt/ui dependency to your project (nxse does not ship with @nuxt/ui, but depends on it)
# Using pnpm
pnpm add nxse @nuxt/ui

# Using yarn
yarn add nxse @nuxt/ui

# Using npm
npm install nxse @nuxt/ui
  1. Add nxse to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@nuxt/ui',
    'nxse'
  ]
})

That's it! You can now use the utilities provided by nxse in your Nuxt project.

Development

# Install dependencies
pnpm install

# Generate type stubs
pnpm dev:prepare

# Playground
pnpm dev

# Documentation
pnpm docs:dev

# Run ESLint
pnpm lint

# Release new version
pnpm release

Special Thanks

  • Awecode for sponsoring this project
  • Nuxt for creating the best framework for Vue
  • Nuxt UI for creating the best UI Library for Nuxt
  • Drizzle for creating the best type-safe ORM

License

MIT License © 2023 Mukund Shah and contributors