Skip to content
This repository was archived by the owner on Jan 6, 2021. It is now read-only.

Latest commit

 

History

History
100 lines (63 loc) · 2.85 KB

README.md

File metadata and controls

100 lines (63 loc) · 2.85 KB

WorkingWaterfronts

An Oregon Sea Grant mobile app for exploring visitor-friendly work sites along the Oregon coast.

IMPORTANT: This repository is no longer under development and has been archived.

Environment Configuration

This list isn't comprehensive currently.

Windows

Install Sencha Cmd (further instructions from BSG).

Install Node, then Command Prompt from any folder, do:

> npm install -g cordova phonegap

Mac/Unix/Linux

$ sudo npm install -g cordova phonegap

Contributing

  1. Ensure that your environment is able to access the above required resources.
  2. Navigate to your development space and run git clone on this repo.
  3. Navigate into the new project directory and run commands from here.

Building/Running Local (web)

$ sencha app build
$ sencha web start

Building Native (iOS)

$ sencha app build native

In order for native device functions to work, plugins must installed. The plugins are saved in config.xml as Feature tags:

<feature name="Geolocation">
	<param name="id" value="org.apache.cordova.geolocation" />
</feature>

These plugins are now automatically installed in a Phonegap hook.

The directory /phonegap/platforms/... contains the Android APK and Xcode project for deploying to either platform.

If there are plugin errors in the app's console log, you may need to delete the /phonegap/platforms/, /phonegap/plugins/, /phonegap/www/ folders, and repeat the build.

Linting

To search the javascript feature code for syntax errors, execute:

$ cd syntax/
$ npm install
$ sh criticize-me.sh

Directory Structure

/.sencha/

Sencha configuration and internal resources. Avoid editing within.

/app/

MVC javascript source that employs Sencha Touch API. Feature code within.

/app.js

The app's entry point. Initializes whole-page views, controllers, etc.

/index.html

The web page template that Sencha loads into.

/phonegap/

Phonegap's config and build folder. Some files generated during builds.

/resources/

Contains app icons, splash screens, images, and SASS.

/syntax/

If your IDE does not have a JS linter, use this one to check your source code.

/tests/

Jasmine unit tests for feature code. Open SpecRunner.html to run.

/touch/

The Sencha Touch API source. Avoid editing within.

Contributors