Quickstart

How to get a local dev environment running in under 5 minutes.

1. Clone the Repository

git clone https://github.com/gregaspan/outline.git
cd outline

2. Create

.env.local

In the project root, create a file named .env.local and add the following variables (replace each <YOUR_…> with your actual keys):

# Supabase
NEXT_PUBLIC_SUPABASE_URL=<YOUR_SUPABASE_URL>
NEXT_PUBLIC_SUPABASE_ANON_KEY=<YOUR_SUPABASE_ANON_KEY>
SUPABASE_SERVICE_ROLE_KEY=<YOUR_SUPABASE_SERVICE_ROLE_KEY>

# Gemini
GEMINI_API_KEY=<YOUR_GEMINI_API_KEY>
NEXT_PUBLIC_GEMINI_API_KEY=<YOUR_PUBLIC_GEMINI_API_KEY>

# ElevenLabs
ELEVENLABS_API_KEY=<YOUR_ELEVENLABS_API_KEY>
NEXT_PUBLIC_ELEVENLABS_VOICE_ID=<YOUR_PUBLIC_ELEVENLABS_VOICE_ID>

# Winston AI
WINSTON_AI_API_KEY=<YOUR_WINSTON_AI_API_KEY>

3. Install Dependencies

Frontend (Next.js)

npm install

Python Service

cd service
pip install -r requirements.txt
cd ..

4. Start Next.js and Python Servers

Start the Next.js App

In the project root:

npm run dev

This will launch Next.js on http://localhost:3000.

Start the Python Microservice

In a separate terminal:

cd service
uvicorn main:app --reload

This will launch the Python service on http://localhost:8000.

5. Verify

  1. Sign Up / Sign In

    • Open http://localhost:3000 in your browser.

    • Click “Sign In” (or navigate to /signin) and complete the Supabase authentication flow.

    • After signing in, you should be redirected to /dashboard.

  2. Upload a Document

    • In the dashboard, use the DocumentUploader component to upload a test file.

    • Confirm that the file appears in your Supabase storage bucket.

If all steps complete successfully, your local Outline environment is up and running. You can now explore additional features, add new API routes, or begin customizing the application.

PreviousOutlineNextDeployment

Last updated