Acadify

Framework7 CLI Options

Framework7 app created with following options:

{
  "cwd": "C:\\Users\\Administrator\\Documents\\Acadify-2.0",
  "type": [
    "pwa",
    "web",
    "capacitor"
  ],
  "name": "Acadify",
  "framework": "react",
  "template": "single-view",
  "bundler": "vite",
  "cssPreProcessor": false,
  "theming": {
    "customColor": true,
    "color": "#ffb689",
    "darkMode": true,
    "iconFonts": true
  },
  "customBuild": false,
  "pkg": "com.acadify.app",
  "capacitor": {
    "platforms": [
      "android",
      "ios"
    ]
  }
}

Install Dependencies

First of all we need to install dependencies, run in terminal

npm install

NPM Scripts

• 🔥 start - run development server
• 🔧 dev - run development server
• 🔧 build - build web app for production
• 📱 build-capacitor-ios - build app and copy it to iOS capacitor project
• 📱 build-capacitor-android - build app and copy it to Android capacitor project

Vite

There is a Vite bundler setup. It compiles and bundles all "front-end" resources. You should work only with files located in /src folder. Vite config located in vite.config.js.

PWA

This is a PWA. Don't forget to check what is inside of your service-worker.js. It is also recommended that you disable service worker (or enable "Update on reload") in browser dev tools during development.

Capacitor

This project created with Capacitor support. And first thing required before start is to add capacitor platforms, run in terminal:

npx cap add android && npx cap add ios

Check out official Capacitor documentation for more examples and usage examples.

Assets

Assets (icons, splash screens) source images located in assets-src folder. To generate your own icons and splash screen images, you will need to replace all assets in this directory with your own images (pay attention to image size and format), and run the following command in the project directory:

framework7 assets

Or launch UI where you will be able to change icons and splash screens:

framework7 assets --ui

Capacitor Assets

Capacitor assets are located in resources folder which is intended to be used with cordova-res tool. To generate mobile apps assets run in terminal:

npx cordova-res

Check out official cordova-res documentation for more usage examples.

Documentation & Resources

• Framework7 Core Documentation

• Framework7 React Documentation

• Framework7 Icons Reference

• Community Forum

Support Framework7

Love Framework7? Support project by donating or pledging on:

• Patreon: https://patreon.com/framework7
• OpenCollective: https://opencollective.com/framework7