NextScribe Documentation

NextScribe is a modern blogging platform built with Next.js, Supabase, and Tailwind CSS. It features a clean, responsive design with dark mode support and markdown-based content creation.

Features

  • 🔐 Secure authentication with Supabase
  • 📝 Markdown editor for posts
  • 🌓 Dark/Light mode support
  • 🎨 Modern UI with Tailwind CSS
  • 📱 Fully responsive design
  • 🚀 Fast and SEO-friendly with Next.js

Prerequisites

  • Node.js 18+
  • pnpm (recommended) or npm
  • A Supabase account

Getting Started

1. Clone the Repository

git clone git@github.com:releasysaas/nextscribe.git
cd nextscribe

2. Install Dependencies

pnpm install

3. Set Up Supabase

  1. Create a new project on Supabase

  2. Import the database schema:

    • Go to your project's SQL Editor
    • Copy the contents of supabase/schema.sql from this repository
    • Paste and run the SQL commands in Supabase's SQL Editor

  3. Go to Project Settings > API and copy the following values:

    • Project URL
    • anon/public key
    • service_role key (for admin operations)

4. Configure Environment Variables

  1. Copy the example environment file:
cp .env.example .env
  1. Update .env with your Supabase credentials:
NEXT_PUBLIC_SUPABASE_URL=your-project-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
NEXT_PUBLIC_SITE_URL=http://localhost:3000
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
NEXT_PUBLIC_ALLOW_SIGNUP=false  # Set to true to enable public signups

5. Run the Development Server

pnpm dev

Visit http://localhost:3000 to see your application.

6. Create Your First User

If signups are disabled (default), create your first user using the provided script:

pnpm create-user your@email.com yourpassword

Deployment on Vercel

  1. Push your code to a GitHub repository

  2. Visit Vercel and create a new project

  3. Import your GitHub repository

  4. Configure environment variables:

    • Add all variables from your .env file to Vercel's environment variables
    • Update NEXT_PUBLIC_SITE_URL to your production URL

  5. Deploy!

Need Help?

If you need assistance or want to report a bug:

  1. Check our GitHub repository for existing issues
  2. Join our community discussions
  3. Contact our support team at support@releasy.xyz