DedrisFramework

DedrisFramework is a free, MIT-licensed UI framework and starter kit for building iOS and Android apps with Apache Cordova. It keeps the stack intentionally simple: HTML, CSS, JavaScript, and Cordova's native bridge.

The project is based on the public direction described at dedrisframework.com: reusable mobile UI components, starter templates, clear Cordova documentation, and curated native-plugin workflows.

Install

DedrisFramework is not published on npm yet. Until the first public npm release, use the compiled files from this repository or install from Git/local paths during app development.

Use the compiled files directly in a Cordova app:

<link rel="stylesheet" href="css/dedris.css">
<script src="js/dedris.js"></script>

For local or Git-based installs before npm publication:

npm install /path/to/DedrisFramework
npm install github:DedrisLab/DedrisFramework

After the package is published to npm, the install command will be npm install dedrisframework.

Cordova quick start

npm install -g cordova
cordova create myApp com.example.myapp MyApp --template ./templates/blank
cd myApp
cordova platform add android
cordova run android

For iOS builds, use macOS with Xcode installed and run cordova platform add ios.

What's included

• src/dedris.css: design tokens, layout primitives, buttons, cards, lists, tabs, forms, alerts, toasts, modals, progress, and mobile app shells.
• src/dedris.js: small dependency-free helpers for tabs, toggles, dismissible alerts, modals, toasts, drawers, theme selection, and Cordova readiness.
• dist/: distributable CSS and JavaScript.
• examples/: browser-friendly examples of the component system, including a full component gallery.
• templates/blank: a minimal Cordova template with DedrisFramework wired in.
• templates/tabs, templates/sidemenu, templates/login, templates/list-detail, templates/onboarding: starter templates matching the public DedrisFramework template gallery.
• docs/: early project notes and component reference.
• data/components.json: component catalogue with classes and copyable snippets.
• data/templates.json: the six starter templates from the public template gallery.
• data/plugins.json: curated Cordova plugin categories from the public plugin directory.

Design principles

• Open by default: MIT licensed, no account, no paid tier.
• Cordova first: designed for WebView apps and native device flows.
• No build step required: drop files into www/ and start composing screens.
• Web-native: accessible HTML, CSS custom properties, and plain JavaScript.

Development

npm run build
npm run check

npm run build copies the framework assets into dist/ and every Cordova template. npm run check validates JavaScript syntax, JSON catalogues, component class references and required template files.

Release preparation notes are in docs/release.md. The project is configured for a future public npm package, but publishing remains a manual maintainer step.

Starter templates

The public site describes six starters. This repo includes each as a Cordova template package:

Template	Package folder	Best for
Blank Starter	templates/blank	Starting fully from scratch
Tabs Starter	templates/tabs	Apps with 3-5 top-level sections
Sidemenu Starter	templates/sidemenu	Content-heavy apps with many sections
Login & Auth	templates/login	Apps that need user accounts
List & Detail	templates/list-detail	Catalogs, feeds and CRUD screens
Onboarding	templates/onboarding	Welcoming first-time users

Use any local template with Cordova's --template flag:

cordova create myApp com.example.myapp MyApp --template ./templates/tabs

Trademark notice

DedrisFramework is an independent community project. It is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation or the Apache Cordova project. Apache Cordova and Cordova are trademarks of the Apache Software Foundation.