Get Started

Hey maker, welcome to ShipSecure!

Here's a quick overview of the boilerplate. Follow along to get your app up and running.

Once you're done, start building your features. Let's ship that startup, SECURELY

Watch the Overview

Get a quick visual tour of ShipSecure and see what's included in the boilerplate:

Start a local server

1. In your terminal, run the following commands one-by-one:

# Clone the repository (replace 'my-saas' with your desired project name)
git clone https://github.com/hasankemaldemirci/shipsecure.git my-saas

# Navigate into the project directory
cd my-saas

# Install all dependencies (Next.js, Prisma, Auth.js, etc.)
npm install

# Remove the original repository connection (you'll connect your own)
git remote remove origin

# Start the development server
npm run dev

Note: Replace my-saas with your desired project name. ShipSecure requires Node.js 18 or greater. Type node -v in your terminal to check your version.

2. Copy .env.example to .env.local to create your environment configuration file:

# Copy the example file to create your local environment file
cp .env.example .env.local

What this does: Creates your local environment file where you'll add your database URL, OAuth credentials, and other secrets.

3. Open http://localhost:3000 in your browser to see your site. And voila!

Note: You will see errors in the console about missing environment variables. This is expected until you configure them in the next steps.

Next Step: After installation, don't forget to customize your brand using the src/config/ files!

Next.js Project Structure

• /app → Pages (1 folder + page.tsx = 1 page)
• /app/api → API routes (1 file = 1 API endpoint)
• /components → React components
• /lib → Helper functions (auth, security, database, etc.)
• /prisma → Database schema and migrations
• /src/config → Configuration files (site, marketing)
  • See Customization Guide

Environment Variables

You'll need to configure environment variables in .env.local:

• DATABASE_URL: PostgreSQL connection string (see Installation Guide for options)
• AUTH_SECRET: Generate with npx auth secret (see Authentication Guide)
• OAuth Credentials: GitHub and/or Google (see Authentication Guide for step-by-step setup)

For detailed environment variable setup, see the Installation Guide.

Initialize Database

After setting up your DATABASE_URL, initialize the database:

npx prisma db push

For detailed database setup instructions, see the Installation Guide.

Next Steps

• Customization Guide - Customize your branding and landing page
• Authentication Setup - Configure GitHub & Google OAuth
• Billing & Payments - Set up Gumroad license verification
• Security Features - Learn about built-in security
• Deployment - Deploy to Vercel or Netlify

That's it! Your secure SaaS boilerplate is ready. Start building your features!