HTML5 app for giving and receiving charity. https://helpinghelena.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.8KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. Helping Helena App
  2. ============
  3. This is a cross-platform app for Helping Helena. It can be
  4. built for most platforms by using either
  5. [Apache Cordova](https://cordova.apache.org) or [NW.js](https://nwjs.io).
  6. [Get prebuilt binaries here](https://build.netsyms.net/job/HelpingHelenaApp/)
  7. Platform Support
  8. ----------------
  9. Tested and should work on:
  10. * Android 5+ (up-to-date WebView implementation required)
  11. * Linux (amd64 and i386)
  12. Not tested but should work on:
  13. * Windows
  14. Building for NW.js
  15. ------------------
  16. Since this is a webapp, there isn't really a build process.
  17. 1. Install [Yarn](https://yarnpkg.com), and run `./yarninstall.sh` to grab dependencies.
  18. 2. Get [NW.js](https://nwjs.io) and unpack it into a folder (we'll use `~/nw.js`).
  19. 3. Move to the `www` folder in this repository and run `~/nw.js/nw .`
  20. 4. The process is basically the same for non-Linux systems, just use the appropriate
  21. version of NW.js.
  22. Building for Cordova/Android
  23. ----------------------------
  24. This assumes you have Cordova and a working Android SDK installed.
  25. 1. Install [Yarn](https://yarnpkg.com), and run `./yarninstall.sh` to grab dependencies.
  26. 2. Run `./removebloat.sh` to cut the APK size in half.
  27. 3. Run `cordova platform add android`.
  28. 4. Run `cordova build android --release`.
  29. License
  30. -------
  31. The code in `www` (except `node_modules`) is licensed under the Mozilla Public
  32. License 2.0. We didn't write the rest, most of it is autogenerated or third-party.
  33. Consult `licenses.txt` or the built-in open source info page for details.
  34. If you're making custom builds and distributing them, you need to [contact us](https://netsyms.com/contact) and
  35. get permission to use the app icon (`logo.png` and the files in `/res`).
  36. If you're building the app for personal use, or you're not using the same name
  37. or logo, you don't need permission.