Installation
Get Shipfastai running locally in under 5 minutes.
Prerequisites
Before you begin, make sure you have:
•Node.js 18 or higher
•Python 3.10 or higher
•Git
•A Supabase account
•A Stripe account (test mode is fine)
Step 1: Clone the Repository
After purchasing, you'll receive access to our private GitHub repository:
git clone https://github.com/Shipfastai/Shipfastai.git
cd Shipfastai
Step 2: Install Frontend Dependencies
cd frontend
npm install
Step 3: Set Up Python Environment
cd ../backend
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install -r requirements.txt
Step 4: Configure Environment Variables
Copy the example environment files:
Frontend
cp frontend/.env.example frontend/.env.local
Backend
cp backend/.env.example backend/.env
Fill in your API keys (see Configuration).
Step 5: Set Up Supabase
1. Create a new Supabase project
2. Run the migrations in supabase/migrations/
3. Copy your project URL and anon key to .env
Step 6: Start Development Servers
Terminal 1 - Frontend
cd frontend
npm run dev
Terminal 2 - Backend
cd backend
uvicorn main:app --reload
Visit http://localhost:3000 to see your app!
Troubleshooting
npm install fails: Make sure you're using Node.js 18+
Python dependencies fail: Try upgrading pip: pip install --upgrade pip
Supabase connection fails: Double-check your environment variables