Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nerc-ceh/nyph-app

πŸ“±New Year Plant Hunt mobile application (BSBI)
https://github.com/nerc-ceh/nyph-app

backbone cordova marionette mobile-app

Last synced: 9 days ago
JSON representation

πŸ“±New Year Plant Hunt mobile application (BSBI)

Awesome Lists containing this project

README

        

# NYPH App

New Year Plant Hunt by BSBI. https://nyph.bsbi.org/

## Contribution

Think you've found a bug or have a new feature to suggest?
[Let us know!](https://github.com/NERC-CEH/NYPH-app/issues)

## Questions

If you have any questions, please feel free to ask on the
[iRecord forum](http://www.brc.ac.uk/irecord/forum/26).

## Configuration

App configuration is hosted in `config/config.js`. **Note:** it should be done
*before* building the code.

## Building

- Install [NodeJS](http://nodejs.org/)
- Install SASS

```bash
gem install sass
```

- Get a copy of the code by running:

```bash
git clone git://github.com/NERC-CEH/NYPH-app.git
```

- Enter the `NYPH-app` directory and install the npm build dependencies:

```bash
cd NYPH-app && npm install
```

### Cordova mobile app

- Build the project:

```bash
grunt cordova
```

- Update Cordova project with new web pages (replaces the www)

```bash
grunt cordova:update
```

### Web app

If you are building for the web platform only:

`Production`

```bash
grunt
```

`Development`

```bash
grunt 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
node config/server.js
```

- Open the app on a browser [http://localhost:8000](http://localhost:8000)

## Authors

[Karolis Kazlauskis](https://github.com/kazlauskis)

## Copyright and license

Code copyright 2016 Centre for Ecology & Hydrology.
Code released under the [GNU GPL v3 license](LICENSE).