Skip to main content

Quick Start Guide

Deploy your professional automotive website in minutes. Choose your preferred deployment method and get started immediately.

Prerequisites

Before you begin, ensure you have:

  • Carapis API Key - Get your key from Carapis Dashboard
  • Domain Name (optional) - For professional appearance
  • Basic Technical Knowledge - Ability to copy-paste commands
  • Internet Connection - Stable connection for deployment

Step 1: Get Your API Key​

  1. Sign up at Carapis Dashboard
  2. Navigate to API Keys section
  3. Create a new API key for your preferred parsers
  4. Copy your API key (keep it secure!)
API Key Format

Your API key will look like this: carsome_parser_sk_1234567890abcdef1234567890abcdef

Deployment Methods​

Quick Setup
  • One command deployment - Fastest way to get started
  • Automatic configuration - No manual setup required
  • Production ready - Optimized for real-world use
  • Easy updates - Simple update process
Docker Benefits
  • Consistent environment - Same setup everywhere
  • Easy scaling - Add more instances as needed
  • Resource efficient - Optimized resource usage
  • Professional deployment - Industry standard approach

Method 2: Vercel Deployment (Free Hosting)​

One-Click Deploy
  • Free hosting - No server costs
  • Automatic deployments - Updates on every push
  • Global CDN - Fast loading worldwide
  • SSL included - Secure by default
Vercel Features
  • Git integration - Deploy from your repository
  • Preview deployments - Test changes before going live
  • Custom domains - Use your own domain name
  • Analytics included - Built-in performance monitoring

Method 3: Railway Deployment​

Simple Cloud Deployment
  • Easy setup - Minimal configuration required
  • Automatic scaling - Handles traffic spikes
  • Database included - Built-in data storage
  • Team collaboration - Share with your team
Railway Benefits
  • Pay per use - Only pay for what you use
  • Git integration - Automatic deployments
  • Environment variables - Secure configuration
  • Custom domains - Professional appearance

Method 4: VPS Deployment​

Full Control
  • Complete control - Customize everything
  • Cost effective - Lower long-term costs
  • Custom setup - Tailored to your needs
  • Professional hosting - Enterprise-grade infrastructure
VPS Requirements
  • OS: Ubuntu 20.04+ or CentOS 8+
  • RAM: 2GB minimum (4GB recommended)
  • Storage: 20GB minimum
  • Node.js: 18+ or Docker

Configuration Options​

Basic Configuration​

Site Information
  • Site Name - Your portal's display name
  • Site Description - Brief description for SEO
  • Site URL - Your custom domain or subdomain
Default Settings
  • Default Region - Your primary market (e.g., malaysia, korea)
  • Default Currency - Your local currency (e.g., MYR, KRW)
  • Default Language - Your preferred language (e.g., en, ko)
Enabled Parsers
  • Encar - Korean automotive market
  • Che168 - Chinese automotive market
  • AutoTrader - US automotive market
  • Mobile.de - German automotive market
  • AutoScout24 - European automotive market

Advanced Configuration​

Performance Settings
  • Cache Duration - How long to cache data
  • Max Listings Per Page - Number of vehicles per page
  • Enable Analytics - Track user behavior
Customization
  • Primary Color - Your brand's main color
  • Secondary Color - Your brand's accent color
  • Logo URL - Your company logo
Security
  • Enable HTTPS - Secure connections only
  • Content Security Policy - Additional security layer
  • API Key Protection - Secure API key handling

Customization​

Branding Customization​

Logo and Branding
  • Upload your logo - Replace default logo
  • Custom colors - Match your brand palette
  • Custom fonts - Use your preferred typography
  • Custom favicon - Your site icon
Content Customization
  • Homepage content - Customize main page
  • About page - Add your company story
  • Contact information - Your business details
  • Footer content - Additional links and info
Feature Customization
  • Enable/disable features - Turn features on/off
  • Custom components - Add your own functionality
  • Custom pages - Add new content pages
  • Custom styling - Modify appearance

Troubleshooting​

Common Issues​

Portal Not Loading
  • Check container status - Verify deployment is running
  • Check logs - Review error messages
  • Restart deployment - Try restarting the service
API Key Issues
  • Verify API key format - Check key is correct
  • Test API connection - Ensure key is working
  • Check permissions - Verify key has required access
Performance Issues
  • Check server resources - Monitor CPU and memory usage
  • Optimize images - Compress and resize images
  • Enable caching - Configure proper cache settings
  • Use CDN - Distribute content globally

Next Steps​

Ready to Launch?
  1. Get Your API Key - Sign up and get started
  2. View Features - See what's included
  3. Customization Guide - Make it yours
  4. Support - Get help when needed
Need Help?

Your automotive website is ready to launch. Follow these steps and have a professional presence online in minutes.

Get Started Now →