How exa-studio/apivault works
Project type and purpose
• ApiVault is a full-stack, containerized web application that catalogs and exposes a searchable vault of public APIs.
• The frontend is built with Nuxt.js/Vue.js (SSR + SPA), and the backend uses Django + Django REST Framework (DRF) with PostgreSQL.
File structure
• Top-level “frontend” and “backend” folders, each with its own Dockerfile, .env.dev, and docker-compose.yml.
• “backend/apivault” Django project, plus three Django apps: authentication, interaction (feedback), and vault (data).
• Configuration artifacts: docker-compose.yml (root & per-service), GitHub Actions workflows (.github/workflows), management commands for data population, DRF-YASG static files for API docs.
• Frontend: nuxt.config.ts, pages/, components/, plugins/, services/ (ApivaultServices, GithubServices), Firebase & Bootstrap plugin clients.
README for additional insights
• Emphasizes Docker Compose orchestration of client, server, and database.
• Workflow: after cloning, front/backend .env setup, then docker-compose up.
• Built-with badges: Nuxt.js, Vue.js, Django.
Elements
• Browser → Frontend (SSR & API proxy)
• Frontend → Backend (REST calls)
• Backend → Database (SQL queries)
• Backend → External Data Source (management commands)
• Frontend → Firebase/Google OAuth
• GitHub Actions → build/test → Docker Registry/Compose
• Blue for user-facing components (Browser, Frontend)
• Green for backend services (Django API)
• Orange for data stores (PostgreSQL)
• Purple for external services
• Gray for CI/CD pipelines