saasmd

0.1.3 • Public • Published

Quick Start

Install Saasmd CLI globally:

npm install -g saasmd

If you don't already have a Nextjs app, run create-next-app with your preferred package manager.

npx create-next-app@latest saasmd-tutorial

or

yarn create-next-app saasmd-tutorial

or

pnpm dlx create-next-app saasmd-tutorial

or

bunx create-next-app saasmd-tutorial

Then go into the directory of your project:

cd saasmd-tutorial

Then run the following command within the directory of your project:

saasmd init

Note: Saasmd is not compatible with the the pages directory.

Commands

Run these commands within the directory of your Nextjs app:

1. saasmd add

Initializes and configures the following packages for your Next.js project, categorized into:

ORM

Drizzle-ORM

  • Based on your chosen database type (PostgreSQL, MySQL, SQLite), Saasmd sets up the required files for Drizzle-ORM, drizzle-zod for validations and and drizzle-kit to manage migrations.
  • Scripts are auto-added to package.json for immediate use of drizzle-kit.

Prisma


Authentication

Auth.js

  • Generates files for Auth.js (Next-Auth), including the latest Drizzle adapter. (For PlanetScale, references are excluded as it doesn't support foreign keys).
  • Generates a generic sign-in component for immediate use within your Next.js project.
  • Wraps the root layout with the auth provider and generates utilities for auth checks and redirects in your Next.js routes.

Clerk

  • Generates files for Clerk including all necessary config.
  • Wraps the root layout with the auth provider and generates utilities for auth checks and redirects in your Next.js routes.

Lucia

  • Generates files for Lucia including all necessary config.
  • Generates UI and API routes for sign-in and sign-up

Kinde

  • Generates files for Kinde including all necessary config.
  • Generates sign in component and route handler

Other

tRPC

  • Generates files to configure tRPC with the app router.
  • Provides client-side tRPC and scaffolds server-side configuration using the experimental server-invoker pattern.
  • Wraps the root layout in the tRPC provider.

Shadcn-UI

  • Installs and configures Shadcn-UI including button and toast components.
  • Inserts the toast-provider (<Toaster />) to the root layout for instant toast notifications in your Next.js app.

Stripe

  • Installs and configures Stripe within your Next.js project so you can start accepting subscription payments.

Resend

  • Installs and configures Resend

Saasmd also adds relevant keys to your .env which you'll need to provide values for.


2. saasmd generate

a) Model:

  • Generates a drizzle schema with column types based on your SQL flavor and database provider.
  • Uses drizzle-zod to generate Zod schemas for frontend and backend validation.
  • Generates queries and mutations for CRUD operations, fully typed and optimized for consumption via a Next.js front-end.

b) Controller:

  • Gives you an option to scaffold tRPC, Server Actions and/or API routes.
  • Uses Zod schemas from models for request validation.
  • Includes built-in error handling for API routes and auto-adding of tRPC routes to the root router.

c) Views:

  • Scaffolds views using Shadcn-UI to enable immediate CRUD operations (including select fields for adding relations and datepickers for dates).
  • Option to use either React Hook Form with tRPC or plain React (useOptimistic and useValidated Form hooks)

Run in non-interactive mode

As of v0.0.23, you can run saasmd init and saasmd add entirely via the command line as follows:

saasmd init -sf yes -pm bun --orm prisma -db pg -a next-auth -ap github discord -mp trpc stripe resend -cl shadcn-ui -ie yes
Command Short Flag Long Option Description Argument
init - - initialise and configure saasmd -
- -sf --src-folder use a src folder yes or no
- -pm --package-manager package manager <pm>
- -cl --component-lib component library <component-lib>
- -o --orm orm <orm>
- -db --db database ("pg", "mysql", "sqlite") <db>
- -dbp --db-provider database provider - important if using drizzle <dbp>
- -a --auth auth <auth>
- -ap --auth-providers auth providers (if using next-auth) <providers>
- -mp --misc-packages packages ("trpc", "shadcn-ui", "resend") <packages>
- -ie --include-example include example yes or no

Contributing

Keen on enhancing Saasmd? Contributions, bug reports, and feature requests are always welcome. Feel free to open an issue or submit a pull request.

To run locally:

pnpm i
pnpm run dev

npm install -g . (in a second terminal - this will then make saasmd available across your machine using "saasmd *command*")

License

MIT

Package Sidebar

Install

npm i saasmd

Weekly Downloads

2

Version

0.1.3

License

ISC

Unpacked Size

1.28 MB

Total Files

174

Last publish

Collaborators

  • gauravmandall
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy