Create-nextsaasify-app NPM

create-nextsaasify-app

create-nextsaasify-app is a CLI tool for quickly setting up a new SaaS project using the NextSaaSBoilerplate. It provides an interactive setup process to customize your new SaaS application with various authentication and database options.

Features

Interactive CLI for project setup
Support for multiple authentication providers (Firebase, Supabase, Clerk)
Support for multiple database options (Firebase, Supabase, MongoDB)
Optional email integration setup
Stripe integration for subscription management
Automatic configuration of selected options
Built with Next.js 14, TypeScript, Tailwind CSS, and Shadcn/UI

Prerequisites

Node.js 14.0.0 or later
npm 6.0.0 or later

Usage

To create a new SaaS project, run:

npx create-nextsaasify-app

Follow the interactive prompts to configure your project:

Enter your project name
Choose your authentication provider
Select your database provider
Decide whether to include Stripe integration
Decide whether to include email integration

After the setup is complete, navigate to your project directory and start the development server.

Configuration

The CLI tool will create a .env.local file in your project root with placeholders for the necessary environment variables. Before running your application, you need to fill these in with your actual credentials:

For Firebase Auth and/or Firebase Database:
- NEXT_PUBLIC_FIREBASE_API_KEY
- NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN
- NEXT_PUBLIC_FIREBASE_PROJECT_ID
- NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET
- NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID
- NEXT_PUBLIC_FIREBASE_APP_ID
For Supabase Auth and/or Supabase Database:
- NEXT_PUBLIC_SUPABASE_URL
- NEXT_PUBLIC_SUPABASE_ANON_KEY
For Clerk Authentication:
- NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
- CLERK_SECRET_KEY
For MongoDB Database:
- MONGODB_URI
For Email Integration (if selected):
- EMAIL_SERVER_USER
- EMAIL_SERVER_PASSWORD
- EMAIL_SERVER_HOST
- EMAIL_SERVER_PORT
- EMAIL_FROM
For Stripe Integration (if selected):
- STRIPE_SECRET_KEY
- NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY
- STRIPE_WEBHOOK_SECRET
- NEXT_PUBLIC_STRIPE_STARTER_PLAN_PRICE_ID
- NEXT_PUBLIC_STRIPE_PRO_PLAN_PRICE_ID

Make sure to obtain these credentials from your respective service providers and update the .env.local file accordingly.

Stripe Integration

If you choose to include Stripe integration, the setup will add the necessary configuration to handle subscription plans. You will need to:

Set up your Stripe account and obtain the API keys.
Update the components/Pricing.tsx to integrate with Stripe checkout for handling subscriptions.
Ensure that the environment variables related to Stripe are correctly set in your .env.local file.

Adding Shadcn/UI Components

To add Shadcn/UI components to your project, use the following command:

npx shadcn-ui@latest add <component-name>

Project Structure

The generated project follows the Next.js 14 App Router structure:

app/: Contains the main application code
components/: Reusable React components
lib/: Utility functions and configurations
public/: Static assets
styles/: Global styles and Tailwind CSS configuration

Customization

Feel free to modify the generated code to fit your specific needs. The boilerplate provides a solid foundation, but you may want to add additional features or modify existing ones.