|
4 years ago | |
---|---|---|
nbproject | 4 years ago | |
packaging | 4 years ago | |
res/android | 4 years ago | |
www | 4 years ago | |
.gitignore | 4 years ago | |
.npmignore | 4 years ago | |
LICENSE.md | 4 years ago | |
README.md | 4 years ago | |
config.xml | 4 years ago | |
index.js | 4 years ago | |
licenses.html | 4 years ago | |
licenses.txt | 4 years ago | |
logo.png | 4 years ago | |
package.json | 4 years ago | |
removebloat.sh | 4 years ago | |
yarn.lock | 4 years ago | |
yarninstall.sh | 4 years ago |
README.md
Helping Helena App
This is a cross-platform app for Helping Helena. It can be built for most platforms by using either Apache Cordova or NW.js.
Platform Support
Tested and should work on:
- Android 5+ (up-to-date WebView implementation required)
- Linux (amd64 and i386)
Not tested but should work on:
- Windows
Building for NW.js
Since this is a webapp, there isn't really a build process.
- Install Yarn, and run
./yarninstall.sh
to grab dependencies. - Get NW.js and unpack it into a folder (we'll use
~/nw.js
). - Move to the
www
folder in this repository and run~/nw.js/nw .
- The process is basically the same for non-Linux systems, just use the appropriate version of NW.js.
Building for Cordova/Android
This assumes you have Cordova and a working Android SDK installed.
- Install Yarn, and run
./yarninstall.sh
to grab dependencies. - Run
./removebloat.sh
to cut the APK size in half. - Run
cordova platform add android
. - Run
cordova build android --release
.
License
The code in www
(except node_modules
) is licensed under the Mozilla Public
License 2.0. We didn't write the rest, most of it is autogenerated or third-party.
Consult licenses.txt
or the built-in open source info page for details.
If you're making custom builds and distributing them, you need to contact us and
get permission to use the app icon (logo.png
and the files in /res
).
If you're building the app for personal use, or you're not using the same name
or logo, you don't need permission.