Skip to content
uc-local-apex-dev

Getting Started

Get your Oracle 23ai database with APEX and ORDS running locally in just a few minutes. This guide will walk you through the complete setup process.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have the following installed:

Required Software

Section titled “Required Software”
  • Docker or Podman (or any docker-compatible container runtime)
  • docker-compose / podman-compose
  • SQLcl with “sql” command in PATH
  • Bash-compatible shell

Platform-Specific Notes

Section titled “Platform-Specific Notes”

macOS Users

Section titled “macOS Users”

If you’re using macOS, read the Podman setup guide for additional configuration steps.

Windows Users

Section titled “Windows Users”

We recommend using WSL2 (Windows Subsystem for Linux) for the best experience.

Quick Setup

Section titled “Quick Setup”

1. Clone the Repository

Section titled “1. Clone the Repository”
Terminal window
git clone https://github.com/United-Codes/uc-local-apex-dev.git
cd uc-local-apex-dev

2. Make Scripts Executable

Section titled “2. Make Scripts Executable”
Terminal window
chmod +x ./local-23ai.sh ./setup.sh ./scripts/*.sh

3. Run Setup

Section titled “3. Run Setup”
Terminal window
# Setup the environment
./setup.sh


# Start the containers (use podman-compose if using Podman)
docker-compose up -d

4. Wait for APEX Installation

Section titled “4. Wait for APEX Installation”

Monitor the ORDS container logs to see the installation progress:

Terminal window
docker logs --follow local-ords

Wait for these key messages:

  • INFO : Database connection established.
  • INFO : Installing APEX on your DB please be patient.
  • INFO : APEX has been installed.
  • INFO : APEX ADMIN password has configured as 'Welcome_1'.

5. Configure Database

Section titled “5. Configure Database”

After APEX installation completes, run the post-installation script:

Terminal window
./scripts/after-first-db-start.sh

Optionally set up local SSL/HTTPS for ORDS.

6. PATH Configuration

Section titled “6. PATH Configuration”

For easier script access, add the repository to your PATH:

Terminal window
# Add to ~/.zshrc or ~/.bashrc
export PATH="/Users/username/path/to/uc-local-apex-dev:$PATH"

Then use scripts from anywhere:

Terminal window
local-23ai.sh create-user newproject
local-23ai.sh backup-all
local-23ai.sh stop

Next Steps

Section titled “Next Steps”

Now that your environment is running:

  1. Create your first workspace: local-23ai.sh create-user myproject
  2. Explore the available scripts: local-23ai.sh --help
  3. Start developing your APEX applications

Troubleshooting

Section titled “Troubleshooting”

ORDS Config Folder Not Writable

Section titled “ORDS Config Folder Not Writable”

If you see APEX as unavailable and the ORDS logs show that the config folder is not writable:

Terminal window
chmod -R 777 ./ords-config
docker-compose restart ords

Access Your Environment

Section titled “Access Your Environment”

Once setup is complete, you can access:

Default APEX Credentials

Section titled “Default APEX Credentials”
  • Username: admin or ADMIN
  • Password: Welcome_1