image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Akan.js v2 docs are now available.View the v1 docs
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
• PWA
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
• PWA
Previous
Kubernetes

PWA

A PWA, or Progressive Web App, is a web app that can feel closer to an installed app. It still runs through the browser, but it can use install metadata, app icons, standalone display, and other browser features to create a more app-like experience.
  • Use it when users repeatedly open the same web app and benefit from a home-screen or desktop launcher.
  • It is useful for admin tools, field-work apps, internal dashboards, lightweight commerce apps, and content apps.
  • Start PWA support by telling the browser what your app is: its name, icon, start URL, display mode, and colors.

When To Use PWA

Think of PWA as a way to make a web app easier to return to. It is not a replacement for every native app, but it is a strong first choice when web deployment speed matters and the app does not need deep device-specific APIs.
  • Good fit: users need quick access to the same workflow every day, such as office tasks, approvals, reports, or checklists.
  • Good fit: you want one deployed web app to cover desktop and mobile without app-store distribution first.
  • Be careful: if the product depends on deep native features, heavy background work, or strict app-store presence, plan a native wrapper or native app too.

Static Manifest File

Use this when you already have a `manifest.json` file or want to edit the exact JSON that the browser reads.
apps/myapp/public/manifest.json
apps/myapp/page/_layout.tsx

Layout Manifest Object

Akan can also read a `manifest` export from the root layout. The object is converted into a manifest link for the document head.
  • Write author-facing keys in camelCase, such as `shortName`, `startUrl`, and `themeColor`.
  • Akan converts them to standard manifest keys like `short_name`, `start_url`, and `theme_color`.
  • This is convenient when the manifest belongs to app code instead of a standalone JSON file.
apps/myapp/page/_layout.tsx

Required Assets

Before testing installation, make sure every URL in the manifest is reachable from the deployed app.
  • `/icon-192x192.png` and `/icon-512x512.png` are good first icon sizes for browser install prompts.
  • `startUrl` is the page that opens when the installed app starts.
  • `scope` limits which URLs belong to the installed app window.
  • `display: "standalone"` makes the app open without the normal browser toolbar.

Tips

  • Start with one simple manifest, then add screenshots, categories, or shortcuts after installation works.
  • If your app is served under a base path, set `startUrl` and `scope` to that path instead of `/`.
  • Use the static JSON file when designers or operators need to review the manifest directly.
  • Use the layout object when you want TypeScript help and app metadata in one place.
PWA
When To Use PWA
Static Manifest File
Layout Manifest Object
Required Assets
Tips