mirror of
https://github.com/dborth/vbagx.git
synced 2024-11-26 04:24:16 +01:00
190 lines
4.7 KiB
Markdown
190 lines
4.7 KiB
Markdown
|
# Comida Cab
|
||
|
|
|
||
|
|
## Framework7 CLI Options
|
||
|
|
|
||
|
|
Framework7 app created with following options:
|
||
|
|
|
||
|
|
```
|
||
|
|
{
|
||
|
|
"cwd": "C:\\android\\projects\\comida-cab-f7-v6",
|
||
|
|
"type": [
|
||
|
|
"web",
|
||
|
|
"pwa",
|
||
|
|
"cordova"
|
||
|
|
],
|
||
|
|
"name": "Comida Cab",
|
||
|
|
"framework": "core",
|
||
|
|
"template": "single-view",
|
||
|
|
"bundler": "webpack",
|
||
|
|
"cssPreProcessor": "less",
|
||
|
|
"theming": {
|
||
|
|
"customColor": true,
|
||
|
|
"color": "#44c950",
|
||
|
|
"darkTheme": true,
|
||
|
|
"iconFonts": true,
|
||
|
|
"fillBars": false
|
||
|
|
},
|
||
|
|
"customBuild": true,
|
||
|
|
"customBuildConfig": {
|
||
|
|
"rtl": false,
|
||
|
|
"darkTheme": true,
|
||
|
|
"lightTheme": true,
|
||
|
|
"themes": [
|
||
|
|
"ios",
|
||
|
|
"md",
|
||
|
|
"aurora"
|
||
|
|
],
|
||
|
|
"components": [
|
||
|
|
"appbar",
|
||
|
|
"dialog",
|
||
|
|
"popup",
|
||
|
|
"login-screen",
|
||
|
|
"popover",
|
||
|
|
"actions",
|
||
|
|
"sheet",
|
||
|
|
"toast",
|
||
|
|
"preloader",
|
||
|
|
"progressbar",
|
||
|
|
"sortable",
|
||
|
|
"swipeout",
|
||
|
|
"accordion",
|
||
|
|
"contacts-list",
|
||
|
|
"virtual-list",
|
||
|
|
"list-index",
|
||
|
|
"timeline",
|
||
|
|
"tabs",
|
||
|
|
"panel",
|
||
|
|
"card",
|
||
|
|
"chip",
|
||
|
|
"form",
|
||
|
|
"input",
|
||
|
|
"checkbox",
|
||
|
|
"radio",
|
||
|
|
"toggle",
|
||
|
|
"range",
|
||
|
|
"stepper",
|
||
|
|
"smart-select",
|
||
|
|
"grid",
|
||
|
|
"calendar",
|
||
|
|
"picker",
|
||
|
|
"infinite-scroll",
|
||
|
|
"pull-to-refresh",
|
||
|
|
"lazy",
|
||
|
|
"data-table",
|
||
|
|
"fab",
|
||
|
|
"searchbar",
|
||
|
|
"messages",
|
||
|
|
"messagebar",
|
||
|
|
"swiper",
|
||
|
|
"photo-browser",
|
||
|
|
"notification",
|
||
|
|
"autocomplete",
|
||
|
|
"tooltip",
|
||
|
|
"gauge",
|
||
|
|
"skeleton",
|
||
|
|
"menu",
|
||
|
|
"color-picker",
|
||
|
|
"treeview",
|
||
|
|
"text-editor",
|
||
|
|
"area-chart",
|
||
|
|
"pie-chart",
|
||
|
|
"elevation",
|
||
|
|
"typography"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"webpack": {
|
||
|
|
"developmentSourceMap": true,
|
||
|
|
"productionSourceMap": true,
|
||
|
|
"hashAssets": false,
|
||
|
|
"preserveAssetsPaths": false,
|
||
|
|
"inlineAssets": true
|
||
|
|
},
|
||
|
|
"pkg": "com.comidacab.app",
|
||
|
|
"cordova": {
|
||
|
|
"folder": "cordova",
|
||
|
|
"platforms": [
|
||
|
|
"ios",
|
||
|
|
"android",
|
||
|
|
"electron"
|
||
|
|
],
|
||
|
|
"plugins": [
|
||
|
|
"cordova-plugin-statusbar",
|
||
|
|
"cordova-plugin-keyboard",
|
||
|
|
"cordova-plugin-splashscreen"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## NPM Scripts
|
||
|
|
|
||
|
|
* 🔥 `start` - run development server
|
||
|
|
* 🔧 `dev` - run development server
|
||
|
|
* 🔧 `build` - build web app for production
|
||
|
|
* 📱 `build-cordova` - build cordova app
|
||
|
|
* 📱 `build-cordova-ios` - build cordova iOS app
|
||
|
|
* 📱 `cordova-ios` - run dev build cordova iOS app
|
||
|
|
* 📱 `build-cordova-android` - build cordova Android app
|
||
|
|
* 📱 `cordova-android` - run dev build cordova Android app
|
||
|
|
* 🖥 `build-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](https://webpack.js.org/guides/asset-management/).
|
||
|
|
## Cordova
|
||
|
|
|
||
|
|
## Cordova Android
|
||
|
|
Cordova Android was installed. To test it, use following command:
|
||
|
|
|
||
|
|
```
|
||
|
|
framework7 cordova run android
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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:
|
||
|
|
|
||
|
|
* [Cordova Electron Platform Guide](https://cordova.apache.org/docs/en/latest/guide/platforms/electron/index.html)
|
||
|
|
* [Official Electron Documentation](https://electronjs.org/docs)
|
||
|
|
|
||
|
|
## 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
|
||
|
|
```
|
||
|
|
|
||
|
|
## To compile after download from github
|
||
|
|
|
||
|
|
After getting project from github
|
||
|
|
|
||
|
|
## Documentation & Resources
|
||
|
|
|
||
|
|
* [Framework7 Core Documentation](https://framework7.io/docs/)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
* [Framework7 Icons Reference](https://framework7.io/icons/)
|
||
|
|
* [Community Forum](https://forum.framework7.io)
|
||
|
|
|
||
|
|
## Support Framework7
|
||
|
|
|
||
|
|
Love Framework7? Support project by donating or pledging on patreon:
|
||
|
|
https://patreon.com/vladimirkharlampidi
|