Skip to content

Quick Start Guide

Get R Commerce up and running in minutes with this quick start guide.

Prerequisites

Before you begin, ensure you have the following installed:

Installation

Option 1: Build from Source

# Clone the repository
git clone https://github.com/creativebastard/rcommerce.git
cd gocart

# Build the project
cargo build --release

# The binary will be at:
# target/release/rcommerce

# Clone the repository
git clone https://github.com/creativebastard/rcommerce.git
cd gocart

# Start all services
docker-compose up -d

# Check status
docker-compose ps

Configuration

The easiest way to configure R Commerce is using the setup wizard:

# Run the interactive setup wizard
./target/release/rcommerce setup

# Or with a specific output file
./target/release/rcommerce setup -o config/production.toml

The wizard will guide you through: - Store configuration (name, currency) - Database setup (PostgreSQL) - Database migrations (with handling for existing databases) - Optional data import from WooCommerce, Shopify, Magento, or Medusa - Server, cache, and security settings - TLS/SSL configuration (including Let's Encrypt) - Payment gateways and email notifications

Option 2: Manual Configuration

Create a config/development.toml file:

[server]
host = "127.0.0.1"
port = 8080

[database]
db_type = "Postgres"
host = "localhost"
port = 5432
username = "rcommerce_dev"
password = "devpass"
database = "rcommerce_dev"
pool_size = 5

[cache]
cache_type = "Memory"

[payment]
test_mode = true

Database Setup

Create Database (PostgreSQL):

# Create database
psql -U postgres -c "CREATE DATABASE rcommerce_dev;"
psql -U postgres -c "CREATE USER rcommerce_dev WITH PASSWORD 'devpass';"
psql -U postgres -c "GRANT ALL PRIVILEGES ON DATABASE rcommerce_dev TO rcommerce_dev;"

Run Migrations:

# If using setup wizard, migrations run automatically
# Otherwise, run manually:
./target/release/rcommerce db migrate -c config.toml

Running the Server

Development Mode

# Run with hot reload
cargo watch -x run

# Or run directly
cargo run

# With specific config
cargo run -- --config config/development.toml

Production Mode

# Build release binary
cargo build --release

# Run with production config
./target/release/rcommerce --config config/production.toml

Verify Installation

Health Check

curl http://localhost:8080/health

Expected response:

{
  "status": "healthy",
  "version": "0.1.0",
  "database": "connected",
  "cache": "connected",
  "timestamp": "2024-01-23T14:13:35Z"
}

Create Your First Product

curl -X POST http://localhost:8080/api/v1/products \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "name": "Test Product",
    "slug": "test-product",
    "description": "A test product",
    "price": 29.99,
    "status": "active"
  }'

Next Steps

Troubleshooting

Port Already in Use

# Find process using port 8080
lsof -i :8080

# Kill the process or use a different port
# Edit config/development.toml and change the port

Database Connection Failed

# Check PostgreSQL is running
pg_isready -h localhost -p 5432

# Check credentials
psql -U rcommerce_dev -d rcommerce_dev -h localhost -W

Build Errors

# Update Rust
rustup update

# Clean and rebuild
cargo clean
cargo build --release

Getting Help

  • Documentation: Browse the full documentation
  • GitHub Issues: Report bugs and request features
  • Discord: Join the community for real-time help