Skip to content

Latest commit

 

History

History
114 lines (88 loc) · 3.95 KB

README.md

File metadata and controls

114 lines (88 loc) · 3.95 KB
Raw

Pergola Frontend

Framework7 CLI Options

Framework7 app created with following options:

{
  "type": [
    "web",
    "pwa",
    "cordova"
  ],
  "name": "Our Garden",
  "pkg": "io.github.communitygarden.ourgarden",
  "framework": "react",
  "template": "tabs",
  "cssPreProcessor": "scss",
  "bundler": "webpack",
  "cordova": {
    "folder": "cordova",
    "platforms": [
      "ios",
      "android",
      "electron"
    ],
    "plugins": [
      "cordova-plugin-statusbar",
      "cordova-plugin-keyboard",
      "cordova-plugin-splashscreen"
    ]
  },
  "webpack": {
    "developmentSourceMap": true,
    "productionSourceMap": true,
    "hashAssets": false,
    "preserveAssetsPaths": false,
    "inlineAssets": true
  },
  "theming": {
    "customColor": false,
    "color": "#007aff",
    "darkTheme": false,
    "iconFonts": true,
    "fillBars": false
  },
  "customBuild": false
}

NPM Scripts

  • 🔥 start - run development server
  • 🔧 dev - run development server
  • 🔧 build-dev - build web app using development mode (faster build without minification and optimization)
  • 🔧 build-prod - build web app for production
  • 📱 build-dev-cordova - build cordova app using development mode (faster build without minification and optimization)
  • 📱 build-prod-cordova - build cordova app
  • 📱 build-dev-cordova-ios - build cordova iOS app using development mode (faster build without minification and optimization)
  • 📱 build-prod-cordova-ios - build cordova iOS app
  • 📱 build-dev-cordova-android - build cordova Android app using development mode (faster build without minification and optimization)
  • 📱 build-prod-cordova-android - build cordova Android app
  • 🖥 build-dev-cordova-electron - build cordova Electron app using development mode (faster build without minification and optimization)
  • 🖥 build-prod-cordova-electron - build cordova Electron app
  • 🖥 cordova-electron - launch quick preview (without full build process) of Electron app in development mode

WebPack

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

Webpack has specific way of handling static assets (CSS files, images, audios). You can learn more about correct way of doing things on official webpack documentation.

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.

Cordova

Cordova project located in cordova folder. You shouldn't modify content of cordova/www folder. Its content will be correctly generated when you call npm run cordova-build-prod.

Cordova Electron

There is also cordova Electron platform installed. To learn more about it and Electron check this guides:

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

Documentation & Resources

Support Framework7

Love Framework7? Support project by donating or pledging on patreon: https://patreon.com/vladimirkharlampidi