nuxt-auto-crud_template

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

nuxt-auto-crud_template

★ 9 Open GitHub ↗

A ready-to-use template for the nuxt-auto-crud module, fully configured with all required prerequisites.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Nuxt Auto CRUD Template

## Introduction

**The Nuxt Auto CRUD Template is the production-ready Nuxt 4 + Nuxt UI 4 implementation of nuxt-auto-crud.** It serves as the blueprint for creating specialized apps with zero-rebuild core logic.

### ⚠️ Compatibility Notice

This template is currently undergoing a major internal refactor to align with the latest version of the **NAC core module** (2.x). Due to active development priorities, full compatibility is expected in a few months.

### 🚀 Getting Started

While the saas template is being updated, please use the minimal starter templates for immediate development:

* **SQLite/libSQL:** [nac-starter](https://github.com/clifordpereira/nac-starter)
* **MySQL:** [nac-starter-mysql](https://github.com/clifordpereira/nac-starter-mysql)

---

## Features
* **Dynamic CRUD**: Fully dynamic logic without code generation.
* **Dynamic Forms & Tables**: Built-in search, pagination, and validation.
* **Relation Handling**: Seamlessly manage database relationships.
* **Admin Dashboard**: Centralized management interface.
* **Auth Ready**: Integrated Social Login and Password Reset.
* **Real-time Sync**: Zero-config SSE broadcasting for instant UI updates. 
> **Note:** Real-time Sync is currently not supported for serverless environments.

## Seeding
* Seeding is triggered upon the first login of `NUXT_ADMIN_EMAIL` (defaults to `admin@example.com`).

## Demo Credentials
Default users initialized during the first-run seed (Password: `$1Password`):

## 🛠 Development Workflow
1.  **Define Schema**: Add your Drizzle table in `server/db/schema/`.
2.  **Generate**: Run `bun db:generate` to migrate the tables (schemas).
3.  **Roles**: (Optional) Configure `rolesToSeed` in `app.config.ts`.
4.  **Permissions**: (Optional) Configure necessary permissions for the resources (tables) in **Admin Dashboard -> Resource Permissions**.
5.  **Guest View**: (Optional) Define public columns in `nuxt.config.ts` under `autoCrud.resources`.

## 🤖 Agentic Ready
This project is optimized for Agentic Workflows using the **Model Context Protocol (MCP)**. It provides structured intelligence to AI agents, allowing them to build, explore, and interact with the application seamlessly.

### Core MCP Servers (Standard)
1.  **`nac-schema-inspector` (Discovery)**: Performs introspection on the runtime engine. Use it to fetch the `/api/_meta` manifest and understand the dynamic schema without reading source files.
2.  **`nuxt` (Framework Intelligence)**: Provides deep context on Nuxt 4 patterns, auto-imports, and directory structures. Essential for framework-native refactoring.
3.  **`nuxt-ui` (Design Logic)**: Real-time documentation for Nuxt UI 4 components. Used by agents to generate premium, `U-` prefixed interfaces consistent with this template.

### Protocol for Agents:
1. **Introspection**: Use `nac-schema-inspector` on `/api/_meta?format=md` to map available pluralized endpoints and data structures.
2. **Standard Implementation**: Leverage `nuxt` and `nuxt-ui` servers to ensure code matches the Nuxt 4 + Tailwind 4 architectural standards.

## Quick Install
```bash
npx nuxi init -t gh:clifordpereira/nuxt-auto-crud_template <project-name>
bun db:generate
bun dev
```

For installing `nuxt-auto-crud` into an existing app, please see [Manual Installation](https://auto-crud.clifland.in/docs/manual-installation).

---
## 🔗 Project Links
- [Documentation](https://auto-crud.clifland.in/docs/auto-crud)
- [YouTube Walkthrough](https://www.youtube.com/watch?v=_o0cddJUU50&list=PLnbvxcojhIixqM1J08Tnm7vmMdx2wsy4B)
- [Core Engine Repo](https://github.com/clifordpereira/nuxt-auto-crud)
- [Creator](https://www.clifland.in/)

nuxt-auto-crud_template

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

nuxt-auto-crud_template

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README