Closes: #163 Signed-off-by: Justin Georgi <justin.georgi@gmail.com> Reviewed-on: #165
2.7 KiB
ALVINN
Framework7 CLI Options
Framework7 app created with following options:
{
"cwd": "/home/mserver/ALVINN/ALVINN_f7",
"type": [
"web",
"pwa",
"cordova"
],
"name": "ALVINN",
"pkg": "edu.midwestern.alvinn",
"framework": "vue",
"template": "single-view",
"cssPreProcessor": false,
"bundler": "vite",
"cordova": {
"folder": "cordova",
"platforms": [
"ios",
"android"
],
"plugins": [
"cordova-plugin-statusbar",
"cordova-plugin-keyboard",
"cordova-plugin-splashscreen"
]
},
"theming": {
"customColor": true,
"color": "#0f206c",
"darkMode": false,
"iconFonts": true
},
"customBuild": false
}
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-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
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.
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.
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/framework7
- OpenCollective: https://opencollective.com/framework7