playbooks

home / skills / littleben / awesomeagentskills / shipany

shipany skill

/shipany

This skill provides comprehensive Shipany development guidance, APIs, and best practices for building, debugging, and deploying Shipany-based SaaS apps.

npx playbooks add skill littleben/awesomeagentskills --skill shipany

Review the files below or copy the command above to add this skill to your agents.

Files (13)
SKILL.md
2.5 KB
---
name: shipany
description: Shipany AI-powered SaaS boilerplate documentation. Use when working with Shipany framework, Next.js 15, TypeScript, Drizzle ORM, NextAuth, payment integration, or building SaaS applications.
---

# Shipany Skill

Comprehensive assistance with shipany development, generated from official documentation.

## When to Use This Skill

This skill should be triggered when:
- Working with shipany
- Asking about shipany features or APIs
- Implementing shipany solutions
- Debugging shipany code
- Learning shipany best practices

## Quick Reference

### Common Patterns

*Quick reference patterns will be added as you use the skill.*

## Reference Files

This skill includes comprehensive documentation in `references/`:

- **api.md** - Api documentation
- **authentication.md** - Authentication documentation
- **components.md** - Components documentation
- **configuration.md** - Configuration documentation
- **database.md** - Database documentation
- **deployment.md** - Deployment documentation
- **features.md** - Features documentation
- **getting_started.md** - Getting Started documentation
- **internationalization.md** - Internationalization documentation
- **other.md** - Other documentation
- **payment.md** - Payment documentation

Use `view` to read specific reference files when detailed information is needed.

## Working with This Skill

### For Beginners
Start with the getting_started or tutorials reference files for foundational concepts.

### For Specific Features
Use the appropriate category reference file (api, guides, etc.) for detailed information.

### For Code Examples
The quick reference section above contains common patterns extracted from the official docs.

## Resources

### references/
Organized documentation extracted from official sources. These files contain:
- Detailed explanations
- Code examples with language annotations
- Links to original documentation
- Table of contents for quick navigation

### scripts/
Add helper scripts here for common automation tasks.

### assets/
Add templates, boilerplate, or example projects here.

## Notes

- This skill was automatically generated from official documentation
- Reference files preserve the structure and examples from source docs
- Code examples include language detection for better syntax highlighting
- Quick reference patterns are extracted from common usage examples in the docs

## Updating

To refresh this skill with updated documentation:
1. Re-run the scraper with the same configuration
2. The skill will be rebuilt with the latest information

Overview

This skill provides AI-powered, hands-on documentation and guidance for building SaaS apps with the Shipany framework. It covers Next.js 15, TypeScript, Drizzle ORM, NextAuth, payment integration, and common SaaS patterns to speed implementation and debugging. Use it to find examples, configuration tips, and deployment advice tailored to Shipany projects.

How this skill works

The skill inspects common Shipany areas: authentication flows, database models, API routes, UI components, and payment integrations. It maps documented patterns and examples to practical steps, recommends configuration values, and surfaces code snippets for Next.js 15 and TypeScript. Use the references to locate detailed files on API, authentication, database, deployment, and payments.

When to use it

  • Starting a new Shipany SaaS project or integrating Shipany into Next.js 15
  • Implementing authentication with NextAuth and Shipany conventions
  • Designing database schemas or queries using Drizzle ORM patterns
  • Adding or debugging payment flows and billing logic
  • Preparing deployment and environment configuration for production

Best practices

  • Follow the getting started guide first to initialize project structure and TypeScript settings
  • Model persistent data with Drizzle ORM migrations and keep schema definitions versioned
  • Centralize auth routes with NextAuth and validate server-side session checks for protected APIs
  • Use typed API route handlers to keep client-server contracts explicit and maintainable
  • Isolate payment logic and webhooks, verify signatures, and test billing flows in sandbox mode

Example use cases

  • Scaffold a Shipany-based SaaS app with Next.js 15 and TypeScript starter templates
  • Implement role-based access using NextAuth and Shipany-provided middleware patterns
  • Create Drizzle ORM models for tenants, subscriptions, and usage metrics
  • Integrate Stripe payments, handle webhooks, and reconcile invoices in the app
  • Prepare CI/CD deployment with environment variable management and recommended build steps

FAQ

Do I need to use Drizzle ORM with Shipany?

No, Drizzle ORM is the recommended default for typed migrations and queries, but you can integrate other ORMs provided you follow Shipany's data access and migration conventions.

Where should I place payment webhook handlers?

Isolate webhook endpoints under a dedicated API route, verify provider signatures, and process events idempotently to avoid duplicate billing actions.