Skip to content
This repository has been archived by the owner on Nov 28, 2023. It is now read-only.

RangerRick/CruiseMonkey

Repository files navigation

Stories in Ready Build Status

CruiseMonkey

CruiseMonkey is an HTML5 app for use on JoCo Cruise Crazy. It is designed to be used while on the cruise for viewing and organizing events, getting information about the ship, and more.

Requirements

  • iOS: Any device supporting iOS 6 or higher
  • Android: Any device supporting Android 4.0.3 or higher
  • Web: A browser capable of modern HTML5

Download

The latest release version of CruiseMonkey is available in the following app stores:

Twit-Arr

CruiseMonkey works just fine in read-only mode, but if you want to be able to create and favorite events, as well as use some of the other features for CruiseMonkey, you must log in with a twit-arr account on my test Twit-Arr server first!

Beta Testing

  • Android (Google Play): Just follow this link to opt-in to betas on the Google Play store.
  • iOS: email me and I will send you an invite for iOS testing. The limit for testers is now 2000 users, so there is no worry about having too many this year!

Bugs and Enhancement Requests

Opening an Issue (Bug or Enhancement)

  • Twit-Arr: If you have found a bug or have an enhancement request for twit-arr, report it at the Twit-Arr github page. You will need to create a GitHub account to do so.
  • CruiseMonkey: Bugs and enhancement requests can be reported at the CruiseMonkey github page. You will need to create a GitHub account to do so.

Quick-Start Developing

Pre-reqs

Before you can build CruiseMonkey, you must first install Node.JS. Once you have done that, run the following commands to set up your environment:

  1. Install "global" commands through NPM: npm install -g @ionic/cli bower webpack webpack-cli
  2. Install JavaScript browser requirements through Bower: bower install
  3. Install local node requirements through NPM: npm install
  4. Set up one or more platforms: cordova platform add ios@5.0.0 or cordova platform add android@6.4.0. You will need to add any platforms to which you wish to target.

Compiling the Javascript

  • To compile the JavaScript once, run: npm run build
  • To continuously compile the JavaScript as you edit: npm run watch

Starting a browser session for this project

  1. Ensure Twit-arr is running as well as MongoDb for it
  2. ionic run browser
  • you can exchange browser for the platform of your choice

Starting an Emulator

  • Android: npm run android
  • iOS: npm run ios

Note that if you run npm run watch in one window and then start the emulator in another, you can live-edit code and it will auto-refresh in the emulator.

Other Commands

  • npm run verbose-build: Do a "verbose" webpack build, which can give more information on what is being done during compilation.
  • npm run genymotion: Run the Android build in the Genymotion emulator rather than the (slower) Android emulator. (Requires a Genymotion installation.)
  • npm run release: Run webpack and build in release mode. This makes a smaller, faster build with unreadable JavaScript.

Contact

Licensing

CruiseMonkey by Benjamin Reed is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Release Notes

The release notes can now be found here.