Skip to main content

Quickstart

Get your first project running in under 5 minutes.

Prerequisites​

  • Node.js 18+ installed
  • npm, yarn, or pnpm

Step 1: Create a Project​

# Create a new SaaS application with Next.js
npx autodeploybase init my-saas-app \
  --framework next \
  --archetype saas \
  --database postgresql

This creates a complete SaaS starter with:

  • User authentication (JWT)
  • Admin dashboard
  • User management
  • Settings pages
  • PostgreSQL database with Prisma

Step 2: Navigate to Project​

cd my-saas-app

Step 3: Set Up Environment​

# Copy environment template
cp .env.example .env

# Edit .env with your database URL
# DATABASE_URL="postgresql://user:password@localhost:5432/my_saas_app"

Step 4: Install Dependencies​

npm install

Step 5: Initialize Database​

# Generate Prisma client
npx prisma generate

# Run migrations
npx prisma migrate dev --name init

# (Optional) Seed with sample data
npx prisma db seed

Step 6: Start Development Server​

npm run dev

Open http://localhost:3000 in your browser.

What's Included​

Pages​

RouteDescription
/Landing page
/loginUser login
/registerUser registration
/dashboardUser dashboard
/adminAdmin panel (admin users only)
/admin/usersUser management
/admin/settingsSystem settings

API Routes​

EndpointMethodDescription
/api/auth/registerPOSTUser registration
/api/auth/loginPOSTUser login
/api/auth/logoutPOSTUser logout
/api/auth/meGETCurrent user
/api/admin/usersGETList users (admin)
/api/admin/settingsGETGet settings (admin)

Adding More Features​

Add Stripe Payments​

npx autodeploybase add payments-stripe

Then configure in .env:

STRIPE_SECRET_KEY=sk_test_...
STRIPE_PUBLISHABLE_KEY=pk_test_...
STRIPE_WEBHOOK_SECRET=whsec_...

Add Analytics​

npx autodeploybase add analytics

Visit /admin/analytics to see the dashboard.

Add Email​

npx autodeploybase add email

Configure your provider in .env:

EMAIL_PROVIDER=resend
RESEND_API_KEY=re_...

Other Archetypes​

E-commerce Store​

npx autodeploybase init my-store --archetype ecommerce --framework next

Includes: Products, cart, checkout, orders, inventory management.

CMS / Blog​

npx autodeploybase init my-blog --archetype cms --framework next

Includes: Posts, pages, categories, media library, markdown editor.

Marketplace​

npx autodeploybase init my-market --archetype marketplace --framework next

Includes: Multi-vendor support, listings, transactions, reviews.

Blank Starter​

npx autodeploybase init my-app --archetype blank --framework next

Minimal setup - add only what you need.

Different Frameworks​

Nuxt 3 (Vue)​

npx autodeploybase init my-vue-app --framework nuxt --archetype saas

SvelteKit​

npx autodeploybase init my-svelte-app --framework sveltekit --archetype saas

Remix​

npx autodeploybase init my-remix-app --framework remix --archetype saas

Deploying​

npm i -g vercel
vercel

Docker​

docker build -t my-app .
docker run -p 3000:3000 my-app

With Docker Compose​

docker-compose up -d

Next Steps​

  1. Customize the UI - Edit components in src/components/
  2. Add business logic - Create new API routes in src/app/api/
  3. Extend the schema - Add models in prisma/schema.prisma
  4. Configure plugins - Edit autodeploy.config.json
  5. Deploy - Push to Vercel, Railway, or your preferred platform