For AI agents: the complete documentation index is available at https://payhon.github.io/AppKernia/en-US/llms.txt, the full documentation bundle is available at https://payhon.github.io/AppKernia/en-US/llms-full.txt, and this page is available as Markdown at https://payhon.github.io/AppKernia/en-US/guide/index.md.
AppKernia

Get started

You do not need to understand every blueprint before trying AppKernia. Run the complete system first, then go deeper into Mobile, Admin, or Server as your work requires.

If you are still deciding whether it fits your project, start with What is AppKernia? for the origin, name, technology choices, real product surfaces, and future direction.

GoalStart hereRequirements
Try the akone binary with SQLiteInstall and deploy akoneSource build today; channels later
See the complete source stackDocker quick startDocker Desktop and Git
Change Go or React sourceSource developmentGo 1.26, Node 24, pnpm 11, Docker
Build Android, iOS, or HarmonyOSMobile developmentHBuilderX and platform toolchains
Build custom bases or releasesMobile packagingHBuilderX, DevEco, and signing
Configure multi-provider pushPush channel configurationProvider accounts and app identity
Inspect queues and handle failuresNotification operationsAdmin notification permission
Integrate or inspect OS permissionsMobile permission centerTarget-platform toolchain
Configure app sharing and scan hostsClient configurationAdmin client-config read access
Understand the repository firstRepository structure5–10 minutes
Decide whether the project fitsWhat is AppKernia?8–12 minutes
Project maturityAppKernia has not published a public akone Release, npm package, Homebrew Formula, or stable version. APIs, migrations, and component contracts may change. Before production use, complete security, performance, and platform acceptance in your own environment.

What a successful first run means

Do not treat “the command printed no error” as the finish line. The checks below cover the Docker source path. For the single binary, follow Install and deploy akone to verify the version, Readiness, sign-in, data path, and backup. A complete local Docker start should meet all of these checks:

  1. PostgreSQL, API, and Admin are healthy in docker compose ps; Migration and Seed exit with 0.
  2. http://localhost:4173/healthz succeeds, the Admin sign-in page loads, and the browser has no blocking console errors.
  3. Sign in with a local account you created through bootstrap-admin; the repository never ships a fixed default password.
  4. Dashboard summary and trend requests finish instead of remaining in Skeleton or error states.
  5. Count a Mobile platform as passed only after its real build, install, or runtime check completes on that target.

If any check fails, go to troubleshooting, keep the first failing command and exit code, and avoid diagnosing from downstream errors.

Where to go after the first run

GoalNext step
Add a business APIRead server conventions and the OpenAPI source
Add an Admin pageConfirm permission, menu, generated client, and bilingual keys
Add a Mobile page or componentContinue with Mobile development and AK UI
Configure share or trusted scan URLsUse Client configuration, then read the Scanner capability
Integrate business notificationsRead notification architecture and the notification API
Configure and preflight providersPrepare accounts and build identity with push channel configuration
Investigate queue or delivery errorsUse notification operations
Package a custom base or releaseFollow Mobile packaging for toolchains and signing
Change auth, authorization, tenancyRead authentication and ownership boundaries
Prepare a contributionFollow the contribution guide and evidence checks

Suggested reading order

  1. Install and deploy akone
  2. Run from the source repository
  3. What is AppKernia?
  4. Architecture
  5. Authentication and sessions
  6. Notification and push architecture
  7. Server API
  8. Mobile components
  9. Mobile packaging
  10. Contributing