The-Homebrew-Cloud/vbagx
2
0
Fork 0
mirror of https://github.com/dborth/vbagx.git synced 2024-11-22 10:39:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
4b4234e395
vbagx/README.md
Juan Carlos Ruvalcaba a23e95ca0a Initial commit
2021-04-13 14:46:54 -07:00

2.8 KiB
Raw Blame History

Comida Cab

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.

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:

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

npm update

If framework7 cli not installed, add it:

npm install -g framework7-cli

Re-add platforms to cordova

framework7 cordova platform add electron@1.1.1
framework7 cordova platform add android@8.1.0

If cordova build has not been made then:

npm run build-dev-cordova

Finally, to test in device or emulator run

framework7 cordova build android
framework7 cordova run android