Overview

🚧 Under construction 🚧

This project is a work in progress, and we're building it in public. DO NOT USE IT. We'll update this notice once the features described here are available for production use.

Zoonk is an open-source app for learning anything using AI. Check out our long-term vision to see how we plan to evolve the product.

Our tech stack

Programming language: Elixir
Framework: Phoenix
Database: PostgreSQL, Ecto
Frontend: LiveView, Tailwind CSS
AI: OpenAI, OpenRouter, Google AI, Together AI
Deployment: Fly.io
File storage: Tigris
Emails: ZeptoMail by Zoho, Swoosh
Payments: Stripe
Background jobs: Oban
Translations: Gettext
Testing: ExUnit
Continuous integration: GitHub Actions
Documentation: ex_doc
Code quality: Credo, mix format, Prettier, styler

Directory structure

.github – GitHub-related files, including CI workflows and Copilot instructions.
assets – CSS and JavaScript files/libraries.
config – Configuration files for dev, test, runtime, and prod environments.
lib – Core application code, covering both business logic and the web interface.
- zoonk – Business logic, schemas, and contexts.
- zoonk_web – Web interface, including API and frontend.
  - components – LiveView (Phoenix.LiveComponent) and function components (Phoenix.Component).
  - controllers – API and web controllers.
  - live – Pages using Phoenix.LiveView.
  - ui_preview – UI component previews.
priv – Static files, migrations, seeds, AI evals, and translations.
test – Application tests.

Next Page → Glossary