Welcome to SuperFast 👋

Let's get your application up and running in minutes. Follow this guide to set up your development environment.

Choose Your Stack

SuperFast supports both MongoDB+NextAuth and Supabase for authentication and database. Choose the stack that best fits your needs.

System Requirements

Before you begin, ensure your development environment includes:

Node.js 18.17 or later (Check with node -v)
Git for version control
A code editor (we recommend Cursor )

1. Clone the Repository

Open your terminal and run these commands:

Terminal

$git clone https://github.com/SuperFasttt/ship-super-fast.git [YOUR_APP_NAME]$cd [YOUR_APP_NAME]$npm install$git remote remove origin

2. Set Up Environment Variables

Copy the .env.example file to create your .env.local file:

Terminal

$cp .env.example .env.local

Then, update the values in your .env.local file with your actual credentials:

Important

Make sure to replace the placeholder values with your actual credentials:

.env.local

# Notion API KeysNOTION_SECRET=your-notion-secretNOTION_DB=your-notion-database-id# MongoDB DatabaseMONGO_URI=your-mongodb-uri# Resend for MailRESEND_API_KEY=your-resend-api-keyFROM_NAME=Your Name [at] SuperFastFROM_EMAIL=your-email@domain.com# Google OAuthAUTH_GOOGLE_SECRET=your-google-oauth-secretAUTH_GOOGLE_ID=your-google-oauth-idAUTH_SECRET=your-auth-secret # Generate with: npx auth secret# Stripe API KeysSTRIPE_SECRET_KEY=your-stripe-secret-keyNEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your-stripe-publishable-keySTRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret# Base URLNEXT_PUBLIC_BASE_URL=http://localhost:3000

3. Start the Development Server

Run the development server:

Terminal

$npm run dev

Open http://localhost:3000 in your browser to see your application.

Don't Worry About Errors

If you see errors related to missing environment variables, don't worry! You can ignore those errors for now. Head to the Integration section to resolve them.

Next Steps

After installation, you'll need to set up your environment variables and configure your backend. Follow the guides in the Environment Setup section to complete the setup.