This app uses the following technologies; familiarity is likely required:
Files are organized as follows:
src/
contains the main app sources.
.tsx
extension (TypeScript with JSX).www/
is autogenerated and should not be modified directly.
src/
and copies needed files here.plugins/
and platforms/
are installed by Cordova when running cordova prepare
.
They should not be checked in.When making code changes, you can execute npm run watch
, which will incrementally
build the app as changes are made. You can serve the www/
folder directly (e.g.
with node's http-server
or similar) and test most features in the browser.
We try to support and shim any necessary native APIs to enable in-browser testing.
It is recommended that you use an IDE that supports TypeScript, such as Visual Studio Code. This makes development much easier, as errors, type definitions, and refactoring support are all provided inline.
Prerequisites:
sudo npm install -g cordova
npm install
npm run build
.cordova platform add ios
(the first time)cordova build ios
cordova run ios --device
cordova platform add android
(the first time)cordova build android
cordova run android --device
To generate the icons and splash screen (after setup steps noted above):
brew install imagemagick
(Mac)./generate-icons.sh
Notes: