https://github.com/nerc-ceh/mysoil-sample-app
mySoil Sample mobile application
https://github.com/nerc-ceh/mysoil-sample-app
backbone cordova marionette mobile-app soil
Last synced: 7 months ago
JSON representation
mySoil Sample mobile application
- Host: GitHub
- URL: https://github.com/nerc-ceh/mysoil-sample-app
- Owner: NERC-CEH
- License: gpl-3.0
- Created: 2017-08-07T09:41:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T15:44:45.000Z (almost 7 years ago)
- Last Synced: 2025-01-24T04:43:46.483Z (9 months ago)
- Topics: backbone, cordova, marionette, mobile-app, soil
- Language: JavaScript
- Homepage: https://mysoilsample.org/
- Size: 18.8 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iRecord Land App
This app started as a clone of the [iRecord App](https://github.com/NERC-CEH/irecord-app) v2.0.0. The build instructions are the same, copied. Initially named mySoil Sample with domain https://mysolisample.org, it has been changed to iRecord Soil at https://soil.irecord.org.uk.
## Configuration
App configuration is hosted in multiple places. **Note:** config changes should be done *before* building the code.
* **Main configuration** in `src/common/config.js`.
* App version/build is set in the package.json
* Cordova config is `config/cordova/cordova.xml`
* [Environmental variables](https://wiki.archlinux.org/index.php/environment_variables) like *INDICIA_API_KEY* can optionally be placed in `.env` file
## Building
- Install [NodeJS](http://nodejs.org/) ( > 4.5)
- Get a copy of the code by running:
```bash
git clone git://github.com/NERC-CEH/mysoil-sample-app.git
```
- Enter the `irecord-app` directory and install the npm build dependencies:
```bash
cd mysoil-sample-app
```
```bash
npm install
```
### Web app
If you are building for the web platform only:
`Production`
```bash
npm run build
```
`Development`
```bash
npm run build:dev
```
This will create a `dist` folder with the app code and its dependencies.
#### Running app locally
- [Express](http://expressjs.com/) framework is provided for a quick
launch of a web server.
```bash
npm start
```
- Open the app on a browser [http://localhost:8000](http://localhost:8000)
### Cordova app
- Initialize the project:
```bash
npm run build:cordova
```
- This will create a `dist/cordova` folder with the cordova project
- *(optionally)* Update Cordova project with new web pages if you have initialized
but have made some source code changes (ie. only replaces the www folder contents)
```bash
npm run build:cordova:update
```
#### Android build
- Generate signed apk files.
```bash
npm run build:cordova:android
```
The build requires an environment variable (single quoted) to locate the android keystore
```bash
KEYSTORE='/Path/to/android.keystore'
```
- Copy `android-armv7.apk` and `android-x86.apk` from `dist/cordova/dist` to the Google Play store.
#### iOS build
- open `dist/cordova/platforms/ios/iRecord Soil App.xcodeproj` in XCode