Documentation

Get started with Cross Write in just a few steps. This guide covers the high-level workflow for setting up and using Cross Write to publish your content across multiple platforms.

Quick Start

Step 1

Install Dependencies

Clone the repository and install dependencies.

Get the latest version of Cross Write from GitHub and run npm install.

Step 2

Setup Environment

Configure your .env file with API keys.

Add your Hashnode & Dev.to API keys to the .env file.

Step 3

Run & Publish

Start the app and begin publishing.

Run npm run dev or npm start and start publishing your content.

How It Works

Publishing Workflow

  1. 1
    Write your content in markdown format
  2. 2
    Configure platforms with your API keys and preferences
  3. 3
    Publish everywhere with a single command
  4. 4
    Monitor results with detailed logs and publishing status

Key Features

Simple Setup

Get started in minutes with minimal configuration required.

Markdown Support

Write in standard markdown and let Cross Write handle the formatting.

Platform Configuration

Configure each platform's specific requirements and preferences.

How It Works

Simple Workflow

Once you have your environment set up, Cross Write provides a web interface where you can:

  • Write or paste your markdown content
  • Select which platforms to publish to
  • Click publish and watch it go live everywhere

No command line needed - just a simple web interface running on localhost.

Environment Setup

Environment Variables

Create a .env file in your project root with the required configuration:

bash
# Database & Authentication
DATABASE_URL=your_neon_postgres_url
AUTH_SECRET="" # Added by `npx auth`
AUTH_TRUST_HOST=true
AUTH_GOOGLE_ID=your_google_oauth_id
AUTH_GOOGLE_SECRET=your_google_oauth_secret

# Email Configuration
RESEND_API_KEY=your_resend_api_key
EMAIL_FROM=noreply@yourdomain.com

# Deployment Mode
# Use your own OpenAI API key
CROSSWRITE_DEPLOYMENT_MODE=SELF_HOST
OPENAI_API_KEY=sk-your-openai-key-here

# App URL
APP_URL=http://localhost:3000

The .env file includes database, authentication, email, and deployment configuration. Currently, only SELF_HOST mode is available, which uses your own OpenAI API key. For detailed setup instructions, check the README.md in the repository.

Ready to Get Started?

For detailed installation instructions, API documentation, and advanced configuration options, check out the complete documentation on GitHub.

View on GitHubFull Documentation