Skylar Ittner cd476b3f6d | 5 years ago | |
---|---|---|
nbproject | 5 years ago | |
res/android | 5 years ago | |
www | 5 years ago | |
.gitignore | 5 years ago | |
.npmignore | 5 years ago | |
LICENSE.md | 5 years ago | |
README.md | 5 years ago | |
config.xml | 5 years ago | |
index.js | 5 years ago | |
licenses.txt | 5 years ago | |
logo.png | 5 years ago | |
package.json | 5 years ago | |
removebloat.sh | 5 years ago | |
yarn.lock | 5 years ago | |
yarninstall.sh | 5 years ago |
README.md
NotePost App
This is a client app for NotePost. It has some offline capabilities and can be built for most platforms by using Apache Cordova for mobile devices or NW.js for PCs.
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:
- Raspberry Pi (using a custom build of NW.js like this one)
- Windows
- MacOS (we don't currently offer Mac builds, see below)
There are no official builds for Mac for a few reasons: we don't own any Mac computers; Mac builds are about 4x the size of the other builds; and the best Mac build we could get working on a Linux build server was a ZIP file. If you want official Mac builds, you'll need to write a working Jenkins build script.
If you want an iOS build, donate $100 for an Apple Developer account. The framework this app uses has an iOS stylesheet, so it'll even look native.
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 name ("NotePost") and icon (logo.png
and the files in /res
).
If you're not customizing anything but simply building the app, you don't need permission,
but we would love if you contact us and let us know.