- Download and install the platform SDKs and/or emulators for the platform you want to develop for (this might take quite a while… so do this first!)
- Download and install node.js
- Make sure you have the git command line tools installed
- Install and install ImageMagick (base toolkit for image processing, here used for splash screen and icon generation)
- Install Cordova:
npm install -g cordova - Install gulp:
npm install -g gulp - MacOSX and Linux users need to install Wine (for executing the Electron Windows build task)
- Download and install Atom or another editor of your choice (free:
notepad, Visual Studio Code; commercial: Sublime Text, WebStorm)
The npm scripts will build iOS, Windows UWP, Android apps as well as desktop applications for Mac OSX, Windows and Linux. To get it working, please do the following:
- After cloning the repo:
npm i --no-progresswithin the root folder of this repository - Run
npm run watch-webto start a live server, which is best when developing the app - Run
npm run watch-allto orchestrate the cordova ios app, the electron app and the webapp with live reloading. - Run
npm run start-webto start the webapp without injecting upcoming changes - Release Mode: Use the following npm scripts to build the apps in release mode
- Run
npm run dist-webto build the web app - Run
npm run dist-mobile-allto build all phone related apps - Run
npm run dist-desktop-allto build all desktop related apps
- Run
Use npm run start-web as mentioned above to start the browser version of BoardZ.
To run the cordova project, open a terminal and point it to dist/mobile. Use one of the following commands to start:
npm run start-mobile-ios: Runs the iOS version of BoardZ. Requires a Macnpm run start-mobile-ios: Runs the Android version of BoardZ. Requires Android SDK to be installed and at least a simulator
To start the electron packaged app, go to build/desktop/build and open one of the directories suiting your current operating system. Then open the executable as used to.
- Any modern web browser (Chrome, Firefox, Edge, Safari) by simply hosting it
- Mobile platforms (iOS, Android, Windows) by packaging the app using Cordova
- Desktop platforms (Windows, Mac OS X, Linux) by packaging the app using Electron
If you want to change Android's SDK version, open cordova/config.xml and search for android-minSdkVersion or android-targetSdkVersion:
android-minSdkVersion: An integer designating the minimum API Level required for the application to run.android-targetSdkVersion: An integer designating the API Level that the application targets. If not set, the default value equals that given to minSdkVersion.
- Angular2, JavaScript framework — HTML enhanced for web apps!
- Bootstrap, responsive layout framework
- AdminLTE, free responsive dashboard template
- Font Awesome, free icon font
- jQuery, JavaScript library required for AdminLTE
- winstore-jscompat, fixes jQuery issues with Windows (Phone) 8 and 8.1 platforms
- FastClick, eliminates the infamous 300 ms lag on touch devices
- HammerJS, for touch interactions
- FontAwesome Images powered by font awesome
- Leaflet, an open-source JavaScript library for mobile-friendly interactive maps
- pNotify UI notification library
- Cordova for mobile apps
- Camera Plugin, allows native camera access
- Geolocation Plugin, allows access to geolocation
- Statusbar Plugin, allows modifying the statusbar
- Electron for desktop applications