Skip to content

bmorrisondev/quillmate

 
 

Repository files navigation

Quillmate

A collaborative writing platform built with Next.js, Supabase, and Clerk.

Prerequisites

  • Node.js (v18 or higher)
  • pnpm or npm
  • Supabase CLI
  • Git

Getting Started

  1. Clone the repository
git clone https://github.com/bmorrisondev/quillmate.git
cd quillmate
  1. Install dependencies
# Using pnpm (recommended)
pnpm install

# Using npm
npm install
  1. Set up Supabase
  • Create a new account at Supabase
  • Create a new project
  • Go to Project Settings > API
  • Copy the Project URL and anon key
  • Create a .env.local file in the root directory and add:
NEXT_PUBLIC_SUPABASE_URL=your_project_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_anon_key
  1. Set up Clerk
  • Create a new account at Clerk
  • Create a new application
  • Copy the keys from Step 2 of the quickstart
  • Add to your .env.local:
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_publishable_key
CLERK_SECRET_KEY=your_secret_key
  1. Apply database migrations
# Using pnpm
pnpm supabase db push

# Using npx
npx supabase db push
  1. Start the development server
# Using pnpm
pnpm dev

# Using npm
npm run dev

The application should now be running at http://localhost:3000

Features

  • Collaborative writing environment
  • Real-time updates
  • Organization support through Clerk
  • Secure authentication and authorization
  • Responsive design

Tech Stack

  • Next.js 15 (App Router)
  • Supabase (Database & RLS)
  • Clerk (Authentication)
  • TypeScript
  • Tailwind CSS

Releases

No releases published

Packages

No packages published

Languages