Try the latest deployed version of the xAPI App directly in your browser!
https://e-ucm.github.io/xapi-app/
_{The GitHub Pages deployment is automatically updated on every push to main.
Note: Some features may require a backend or specific environment variables.
For full functionality, see local or Docker usage below.}

xAPI App

This project is a containerized web application for xAPI data handling and visualization. It uses Docker Compose for orchestration and includes a frontend (Vite + React/TypeScript), a Caddy reverse proxy, and supporting scripts for development and production.

Features

• Frontend built with Vite, React, and TypeScript
• Caddy server for HTTPS/HTTP reverse proxy
• Docker Compose orchestration
• Environment-based configuration
• Easy start/stop/restart/build/logs via scripts

Prerequisites

• Docker and Docker Compose
• (Optional) Node.js and pnpm for local frontend development

Getting Started

1. Clone the repository

git clone <repo-url>
cd xapi-app

2. Configure Environment Variables

Copy the template and edit as needed:

cp .env.template .env
# Edit .env with your preferred settings

3. Run with Docker Compose

Use the provided script to manage the app:

On Linux/macOS (bash):

./run.sh start

On Windows (PowerShell):

./run.ps1 start

Available Commands

• start : Bring up containers (docker compose up)
• stop : Stop and remove containers (docker compose down)
• restart : Stop then start (default)
• build : Build or rebuild services (docker compose build)
• logs : Follow container logs (docker compose logs -f)
• status : Show running containers (docker compose ps)
• exec : Execute a command in a running container (docker compose exec)
• backup : Run backup scripts (custom, if implemented)
• restore : Run restore scripts (custom, if implemented)
• help : Show help message

4. Access the App

• The frontend will be available at the URL shown in the logs (typically http://localhost or https://localhost).
• Caddy handles HTTPS if enabled in .env.

Development

• The frontend source is in app/.
• To run the frontend locally (without Docker):

   cd app
   pnpm install
   pnpm dev

File Structure

• app/ : Frontend source code (Vite + React)
• caddy/ : Caddy reverse proxy config
• docker-compose.yml : Main Docker Compose file
• run.sh/run.ps1 : Management scripts
• .env.template : Example environment config

License

MIT or as specified in the repository.