hcp-sample v4.0.0-beta.5

HCP-Sample 3.0 application

Synergistix HCP-Sample Solution. Universal application for Phone, Tablet & Desktop.

Getting Started

• Software dependencies.

  Make sure to have the latest version of nodeJS and git installed. This application also requires "syn-lib" ExtJS add-ons repository. Please checkout this reference Using ExtJS add-ons, and don't forget to require your classes to be accesible in this project.

• Installation process.

    npm install git+https://devops.sds.com/DefaultCollection/SynDev/_git/hcp-sample

# this should run dev:desktop option
npm start

Build

# this should run by profile & environment (testing/production)
npm run build:desktop:testing
npm run build:phone:production

# this should run all profiles for the environment specified (testing/production)
npm run build:production

Test

# run all test suites
npm test

# watch all test suites, with any changes, should run all test suites.
npm run test:watch

# watch for an specific test suite, filter by filename (MainViewPackage.test.js)
npm run test:watch MainViewPackage

Contribute

• At your terminal

  If you haven't already, setup your local git config properly (see how) and follow these steps to contribute to the project.

  1. Clone the repo

     git clone https://devops.sds.com/DefaultCollection/SynDev/_git/hcp-sample

     or pull from origin/master is already cloned.

     git pull --ff-only origin master

  2. Install node dependencies.

      npm clean-install

  3. Create working branches for all new development and bug fixes.

     git checkout -b working/{new_branch_name}

  4. Use Jest tests to drive your development.

  5. Commit your work frequently.

     git add {file1_test} {file1} {other_file}
     git commit -m "Descriptive message"

  6. When considered pertinent, push your changes to the server for everyone to see.

     git push origin working/{branch_name}

  7. Once the pull request associated with this branch at the server has been completed, you can dispose your local working branch too.

     git switch master
     git branch -D working/{branch_name}

  8. Repeat steps 2 to 7 for every work item assigned to you and requiring a contribution to this project.

• At the server

  • When ready to integrate your work, create a pull request in order to be reviewed by others.

  • Once your changes has been approved by each reviewer, complete the pull request. This will efectively merge your work into master and delete the working branch.

Collaborate

• At your terminal

  • Update the list of remote branches and checkout a particular working branch where you need to collaborate.

       git remote update origin --prune
       git checkout --track origin/working/{collaboration_branch}

  • Repeat steps 4 to 6 of previous section for a sucessfull collaboration.

Learn more

• Git Reference
• Branching Patterns
• Microsoft Release flow
• Node.js Documentation
• npm CLI Documentation