Getting Started

Preliminary GitHub Setup

  1.  first create an account on github.com if you don't already have one
    
  2.  login to github
    
  3.  visit https://github.com/ml5174/sacpcp and fork the main source repo
    
  4.  visit https://github.com/ml5174/savi-lib fork the library source repo
    

Development Environment Setup

Development Environment Setup - Preliminary

  1.  install LTS build of node from https://nodejs.org/en/download/  
    
  2.  Clone from your sacpcp fork:
     git clone https://github.com/githubusername/sacpcp.git
     where githubusername is your username on github
     and the path given to clone is for your sacpcp fork
    
  3.  cd sacpcp
    
  4.  cd src
    
  5.  Clone from your savi-lib repo into a subfolder of src:
     git clone https://github.com/githubusername/savi-lib.git lib
     where githubusername is your username on github
     and the path give to clone is for your lib fork
     NOTE: your lib subfolder of src needs to be named lib
     If you failed to give the lib argument as target name, then rename the lib folder to lib
    

Development Environment Setup - Secondary

  1.  At this point you could run Thaddeus's npm command:
     npm run setup https://github.com/githubusername/sacpcp.git
     where githubusername is your username on github
     See npm_setup.md for more information
    
  2.  -OR- do the detailed steps that follow:
    
  3.  cd lib
    
  4.  Set the upstream master for lib:
     git remote add upstream https://github.com/ml5174/savi-lib.git
    
  5.  git checkout master
    
  6.  git pull upstream master
    
  7.  cd ../..
    
  8.  Set the upstream master for the main source:
     git remote add upstream https://github.com/ml5174/sacpcp.git
    
  9.  git checkout master
    
  10.  git pull upstream master
    
  11.  Once you cloned the repo to your desktop and have node installed you need to cd to the project and type:
     npm install
    
  12.  Now install cordova and ionic. if on macOS, you may need to prefix this command with sudo:<br>
     npm install -g cordova ionic
    

Launching the application

  • If all went well, you should be able to launch the application to your default browser:
    ionic serve

  • If on macOS, then try adding ios platform:
    ionic platform add ios

    • If you get errors with bower, then try:
      sudo npm install -g bower
  • You may also try adding android platform:
    ionic platform add android

If having issues, then check your software installation versions with ionic info and npm --version output:

ionic info

Your system information:

Cordova CLI: 6.5.0
Ionic Framework Version: 2.0.0-rc.5-201701112208
Ionic CLI Version: 2.2.1
Ionic App Lib Version: 2.2.0
Ionic App Scripts Version: 1.0.0
ios-deploy version: 1.9.1
ios-sim version: 5.0.13
OS: macOS Sierra
Node Version: v6.9.4
Xcode version: Xcode 8.2.1 Build version 8C1002

npm --version
3.10.10

See CONTRIBUTING.md for detailed git operations where developers follow a preferred workflow with pull requests to upstream master coming from their github forks