First Steps

Guide for adding Auto Crud to an existing application.

Prerequisites

Nuxt.js Modern Full-Stack Framework
NuxtHub Helps Build and deploy Nuxt applications
Drizzle ORM Type-Safe ORM for SQL Databases

Installation steps for these prerequisites are detailed in the following sections.

Once installed, all you need to do is:

Define your model schemas in /server/database/schema.ts.
Run bun run db:generate.
That's it! Your CRUD endpoints are ready:

   - POST /api/<resource> -> create
   - GET /api/<resource> -> list
   - GET /api/<resource>/:id -> read
   - PUT /api/<resource>/:id -> update
   - DELETE /api/<resource>/:id -> delete

The following sections explain how to install these prerequisites.

Auto Crud

Auto Crud is a lightweight CRUD engine that exposes RESTful CRUD endpoints for your data models with just the schemas defined.

Install Nuxt.js

For detailed steps, refer to https://nuxt.com/docs/getting-started/installation.