apprun

A lightweight BaaS (Backend as a Service) framework built with Go following the BMad Method.

---

🚀 What is apprun?

apprun is a modular, cloud-neutral BaaS platform that provides:

• Authentication & Authorization: User management and RBAC
• Data Management: RESTful APIs with PostgreSQL and Ent ORM
• Storage Service: File storage with pluggable backends
• Workflow Engine: Business process automation
• Real-time Features: WebSocket support
• Multi-tenant: Project-based resource isolation

Key Features:

• 🔒 Security-first design
• 🌍 Internationalization support
• 🔌 Plugin architecture
• ☁️ Cloud-neutral deployment
• 📦 Production-ready

---

📦 Deployment

Prerequisites

• Docker 20.10+
• Docker Compose 2.0+
• Go 1.23+ (for local development)

Quick Start

# Clone repository
git clone https://github.com/Websoft9/apprun.git
cd apprun

# Start services
docker-compose up -d

# Access application
# API: http://localhost:8080
# Swagger UI: http://localhost:8080/api/docs/index.html

Local Development

Build and run locally:

# Build the binary
make build

# Configure CLI (first time)
cd core
./bin/apprun configure

# Start the server
./bin/apprun serve

# Or use Makefile target
make app-start

CLI Commands:

# View all commands
./bin/apprun --help

# Server commands (local operations)
./bin/apprun serve                  # Start HTTP server
./bin/apprun migrate status         # Check migration status
./bin/apprun migrate apply          # Apply migrations
./bin/apprun configure              # Configure CLI settings
./bin/apprun version                # Show version info

# Legacy compatibility
./bin/server                        # Symlink to apprun, still works

For complete CLI reference, see docs/cli-reference.md.

Production Deployment

# Use production configuration
docker-compose -f docker-compose.yml up -d

# Check service health
curl http://localhost:8080/health

Configuration:

• Environment variables: See docker-compose.yml
• Secrets: Use Docker secrets or external secret manager
• Database: PostgreSQL 14+ (included in docker-compose)

---

🤝 Contributing

We follow the BMad Method for AI-assisted development.

Get started:

1. Read CONTRIBUTING.md
2. Check Sprint Artifacts
3. Follow Standards
4. Submit Pull Request

For maintainers: See OWNER.md

---

📚 Documentation

• Product Requirements
• Architecture
• Technical Standards
• Sprint Artifacts

---

📄 License

MIT License

---

Maintained by: Websoft9