Getting Started with Parslinks

This guide will walk you through creating your account, setting up your first organization, and deploying your first project on Parslinks.

Creating Your Account

1. Sign Up: Visit the Parslinks website and click "Sign Up"

2. Choose Authentication: You can sign up using:

   • Email and password
   • GitHub account
   • Google account
   • Magic link (passwordless)

3. Verify Email: If you signed up with email, verify your email address

4. Complete Profile: Add your name and profile information

Creating Your First Organization

Organizations are the top-level container for your projects. They allow you to:

• Group related projects together
• Manage team members and permissions
• Handle billing and subscriptions
• Share resources across projects

Steps to Create an Organization

1. Navigate to Dashboard: After signing in, you'll be on the dashboard

2. Create Organization: Click "Create Organization" button

3. Fill Details:

   • Organization Name: Choose a unique name
   • Organization Slug: This will be used in URLs (e.g., yourorg.parslinks.com)
   • Description: Optionally describe your organization

4. Select Plan: Choose a pricing plan (you can start with the free plan)

5. Submit: Click "Create Organization"

Creating Your First Project

Projects are individual applications or websites within an organization.

Step 1: Create a New Project

1. Select Organization: Make sure you're in the right organization
2. Click "New Project": Find the button in the dashboard
3. Enter Project Details:
   • Project Name: Give your project a descriptive name
   • Project Slug: URL-friendly identifier
   • Framework: Select your framework (Next.js, React, Vue, etc.)
   • Repository URL: Optional - connect your Git repository

Step 2: Configure Build Settings

Configure how your project should be built:

# Build Command (example for Next.js)
npm run build

# Install Command
npm install

# Output Directory
.next

# Framework Preset
Next.js

Step 3: Set Environment Variables (Optional)

Add any environment variables your application needs:

DATABASE_URL=postgresql://...
API_KEY=your-api-key
NEXT_PUBLIC_API_URL=https://api.example.com

Step 4: Deploy

1. Click "Deploy": Start your first deployment
2. Monitor Progress: Watch the build logs in real-time
3. Access Your Site: Once deployed, you'll get a URL like project-slug.parslinks.app

Understanding Your First Deployment

After deployment, you'll see:

Deployment Dashboard

• Status: Live, building, or failed
• URL: Your application's live URL
• Build Logs: Complete build output
• Deployment Time: How long the build took
• Commit: Git commit information (if connected)

Deployment URL

Your project will be accessible at:

https://[project-slug].[organization-slug].parslinks.app

Next Steps

Now that you have your first project deployed, you can:

Common First-Time Tasks

Connecting a Git Repository

1. Navigate to Project Settings → Git Integration
2. Choose your Git provider (GitHub, GitLab, Bitbucket)
3. Authorize Parslinks to access your repositories
4. Select the repository to connect
5. Choose the branch to deploy (usually main or master)

Enabling Automatic Deployments

1. Go to Project Settings → Deployments
2. Enable Auto Deploy for your chosen branch
3. Now, every push to that branch will trigger a deployment

Setting Up Preview Deployments

Preview deployments create a unique URL for each pull request:

1. Go to Project Settings → Deployments
2. Enable Preview Deployments
3. Choose which branches should trigger previews

Troubleshooting Your First Deployment

Build Failed

If your build fails:

1. Check Build Logs: Look for error messages in the deployment logs
2. Verify Build Command: Make sure your build command is correct
3. Check Dependencies: Ensure all dependencies are listed in package.json
4. Environment Variables: Verify all required environment variables are set

Site Not Loading

If your deployed site doesn't load:

1. Check Deployment Status: Make sure deployment completed successfully
2. Verify Output Directory: Ensure the output directory matches your framework
3. Check Start Command: For SSR apps, verify the start command
4. Review Logs: Check runtime logs for errors

Quick Reference

Framework Presets

Environment Variable Naming

• Public Variables (exposed to browser): NEXT_PUBLIC_*, VITE_*, REACT_APP_*
• Private Variables (server-only): No specific prefix needed

Getting Help

If you're stuck:

• Check the Troubleshooting Guide
• Visit the Dashboard Overview to understand the interface
• Contact support through the dashboard

Congratulations! You're now ready to build and deploy amazing applications with Parslinks! 🎉