Guides

Get Scriptly up and running in just 5 minutes

Steps:

1. 1Clone the repository
2. 2Install dependencies with npm install
3. 3Copy .env.example to .env.local
4. 4Add your Supabase credentials
5. 5Run npm run dev

Create and edit your first markdown document

Steps:

1. 1Sign in to your account
2. 2Click "New Document"
3. 3Start typing in markdown
4. 4See live preview on the right
5. 5Document auto-saves

Configure SMTP to send documents via email

Steps:

1. 1Run email_history_schema.sql in Supabase
2. 2Get Gmail app password from Google
3. 3Add SMTP credentials to .env.local
4. 4Restart development server
5. 5Test by sending yourself an email

Share documents with others via email

Steps:

1. 1Open a document in the editor
2. 2Click Export → Send via Email
3. 3Enter recipient email address
4. 4Choose attachment format (optional)
5. 5Click Send Email

Configure Google Gemini API for AI features

Steps:

1. 1Visit Google AI Studio
2. 2Sign in with Google account
3. 3Generate a free API key
4. 4Open AI Settings in Scriptly
5. 5Paste your API key and save

Improve your writing with AI

Steps:

1. 1Select text in your document
2. 2Click the AI button in toolbar
3. 3Choose an action (improve, summarize, etc.)
4. 4Review AI suggestions
5. 5Apply or modify as needed

Get AI suggestions as you type

Steps:

1. 1Open AI Settings dialog
2. 2Toggle "AI Auto-Complete" on
3. 3Start typing in the editor
4. 4Press Tab to accept suggestions
5. 5Press Esc to dismiss

Set up your database and authentication

Steps:

1. 1Create a Supabase account
2. 2Create a new project
3. 3Run schema.sql in SQL Editor
4. 4Copy project URL and anon key
5. 5Add to .env.local file

Set up user accounts and sign-in

Steps:

1. 1Ensure Supabase is configured
2. 2Run authentication schema
3. 3Test sign-up flow
4. 4Test sign-in flow
5. 5Verify user in Supabase dashboard

Customize the editor appearance

Steps:

1. 1Open tailwind.config.ts
2. 2Modify color variables
3. 3Update CSS custom properties
4. 4Test in light and dark modes
5. 5Save and restart server

Deploy Scriptly to Vercel or Netlify

Steps:

1. 1Push code to GitHub
2. 2Connect to Vercel/Netlify
3. 3Add environment variables
4. 4Configure build settings
5. 5Deploy and test