Skip to main content

Getting Started with Deployxa

Welcome to Deployxa! This guide will help you deploy your first application in under 5 minutes.

What You'll Learn​

  • Create a Deployxa account
  • Connect your GitHub repository
  • Deploy your first application
  • Access your live application

Prerequisites​

  • A GitHub account
  • A repository with your application code
  • 5 minutes of your time

Step 1: Create Your Account​

  1. Visit deployxa.com
  2. Click "Get Started" or "Sign Up"
  3. Sign up with your email or GitHub account
  4. Verify your email address
  5. Complete your profile

Step 2: Create an Organization​

Organizations help you manage projects and team members.

  1. Click "Create Organization"
  2. Enter your organization name (e.g., "my-company")
  3. Choose your plan (Free tier is perfect for getting started)
  4. Click "Create Organization"

Step 3: Connect GitHub​

Deployxa needs access to your GitHub repositories to deploy your code.

  1. Go to Settings → GitHub Integration
  2. Click "Connect GitHub"
  3. Authorize Deployxa to access your repositories
  4. Select which repositories to grant access to

Note: You can always update repository access later.

Step 4: Create Your First Project​

  1. Click "New Project" or "Create Project"
  2. Select your GitHub repository
  3. Deployxa will automatically detect your framework
  4. Review the detected settings:
    • Framework: (e.g., Next.js, React, Laravel)
    • Build Command: (e.g., npm run build)
    • Output Directory: (e.g., .next, dist)
  5. Click "Create Project"

Step 5: Deploy Your Application​

  1. Click "Deploy" on your project dashboard
  2. Watch the deployment progress:
    • Cloning repository
    • Installing dependencies
    • Building application
    • Creating container
    • Deploying to edge network
  3. Wait for deployment to complete (usually 30-60 seconds)

Step 6: Access Your Live Application​

Once deployment completes:

  1. You'll see your application URL: https://your-project.deployxa.app
  2. Click the URL to view your live application
  3. Share it with the world!

Understanding Your Dashboard​

Your project dashboard shows:

  • Overview: Project status, recent deployments, resource usage
  • Deployments: List of all deployments with status and logs
  • Domains: Custom domain configuration
  • Environment: Environment variables and secrets
  • Logs: Real-time application logs
  • Analytics: Performance metrics and usage statistics

Next Steps​

Now that you've deployed your first application, you can:

  1. Add a Custom Domain: Connect your own domain name
  2. Set Environment Variables: Configure API keys and secrets
  3. Enable Preview Deployments: Test changes before production
  4. Configure Monitoring: Set up alerts and health checks
  5. Explore the CLI: Deploy from your terminal

Common Issues​

Build Failed​

Problem: Deployment shows "Build Failed"

Solution:

  • Check build logs for specific errors
  • Verify build command is correct
  • Ensure all dependencies are in package.json

Framework Not Detected​

Problem: Deployxa shows "Unknown Framework"

Solution:

  • Manually select your framework
  • Verify package.json or framework config exists
  • Check repository structure

Deployment Timeout​

Problem: Deployment takes too long

Solution:

  • Check for large dependencies
  • Optimize build process
  • Consider upgrading plan for more resources

Getting Help​

If you need assistance:

  • Documentation: Browse our comprehensive guides
  • Community: Join our Discord community
  • Support: Contact support@deployxa.com
  • Status: Check system status at status.deployxa.com

What's Next?​

Congratulations! You've successfully deployed your first application with Deployxa. Welcome to the platform!