Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ This directory contains scripts and configuration files to set up a complete dev

## Quick Start

**For Development (Simple Workflow):**
```bash
# 1. One-time setup - installs dependencies and starts services
./setup-dev.sh

# 2. Build the application
cargo build

# 3. Run the application (migrations run automatically)
cargo run
```

**For Manual Step-by-Step Setup:**

1. **One-time setup** (installs all dependencies):
```bash
./setup-dev.sh
Expand All @@ -25,7 +39,7 @@ This directory contains scripts and configuration files to set up a complete dev

- **`env.development`** - Environment variables for development
- **`docker-compose.yml`** - PostgreSQL service configuration
- **`scripts/init-db.sql`** - Database initialization script
- **`migrations/`** - Database migration files (replaces deprecated init-db.sql)

### Scripts

Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ A cloud-native solution for providing Redis-as-a-Service on Kubernetes, accessib

This project provides the management API and control plane for RedisGate. The development environment includes PostgreSQL for metadata storage, but actual Redis instances are managed by the Kubernetes operator.

**Simple Development Setup:**
```bash
# One-time setup (installs all dependencies and starts services)
./setup-dev.sh

# Build and run the application (migrations run automatically)
cargo build
cargo run
```

**Alternative using Make commands:**
```bash
# One-time setup (installs all dependencies)
./setup-dev.sh
Expand Down
6 changes: 6 additions & 0 deletions scripts/init-db.sql → scripts/init-db.sql.deprecated
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
-- *** DEPRECATED - DO NOT USE ***
-- This file has been replaced by SQLx migrations in the migrations/ directory.
-- Using this file will cause conflicts with the migration system.
-- See migrations/README.md for more information.
-- *** DEPRECATED - DO NOT USE ***

-- RedisGate Development Database Initialization
-- This script sets up the initial database schema for development

Expand Down
2 changes: 1 addition & 1 deletion setup-dev.sh
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ main() {
echo "Configuration files:"
echo " - Environment: $ENV_FILE"
echo " - Docker Compose: $PROJECT_ROOT/docker-compose.yml"
echo " - Database Init: $PROJECT_ROOT/scripts/init-db.sql"
echo " - Database Migrations: $PROJECT_ROOT/migrations/"
echo ""
}

Expand Down