Getting Started

Requirements

Docker & Docker Compose
Python 3.10+ (if not using Docker)
Node.js 18+ (if not using Docker)

Quick Start (All-in-One Docker)

Note: This setup is for preview and testing purposes only. Please use with caution in production environments.

Run RiceBall with a single command using our All-in-One Docker image (includes SQLite & Local Storage):

docker run -d \
  -p 8000:8000 \
  -e SUPERUSER_EMAIL=admin@admin.com \
  -e SUPERUSER_PASSWORD=admin123456 \
  -v riceball_storage:/app/storage \
  --name riceball \
  ghcr.io/riceball-ai/riceball:all-in-one-latest

Visit http://localhost:8000 to start using RiceBall. You can configure the initial superuser credentials via the SUPERUSER_EMAIL and SUPERUSER_PASSWORD environment variables.

Production Deployment (Source Code)

For production environments requiring PostgreSQL and S3, you can deploy from source:

Clone the repository:

git clone https://github.com/riceball-ai/riceball.git
cd riceball

Configure Environment Variables: Copy the backend example configuration file:
```
cp backend/.env.example backend/.env
```
You can modify the configuration in backend/.env as needed (e.g., database password, API keys).
Start Services: Start all services (backend, frontend, database) using Docker Compose:
```
docker compose -f docker-compose.prod.yml up
```
The container will automatically run database migrations, initialize system configuration, and create a default superuser upon startup.
Access the Application: Open your browser and visit http://localhost:3000 to start using RiceBall.
Default Admin Credentials:
- Email: admin@admin.com
- Password: admin123456

Using Just (Optional)

If you have Just installed, you can use the following shortcut commands:

Start development environment: just dev