1.0.0 • Published 4 years ago

expert-review-tool v1.0.0

Weekly downloads
-
License
-
Repository
-
Last release
4 years ago

eMammal Expert Review Tool (ERT)

Links

MAKE SURE YOU HAVE EMAMMAL AWS KEYS BEFORE YOU DO ANYTHING: Please contact eMammal team to get you set up

MAKE SURE YOU HAVE AN AWS CLI PROFILE CALLED emammal BEFORE YOU TRY TO PUSH ANYTHING UP TO S3 BUCKETS

Dev Repo: https://app.assembla.com/spaces/2250_emammal/git-4/source

  • Most up to date code on release-1.0.0 branch
  • develop branch should match latest staging code
  • master branch should match latest prod code
  • Using semver tags for releases to production, latest tag is currently release-1.01.02 as of 8/24/17
  • NOTE Code also lives here https://github.com/Smithsonian/eMammal_Expert_Review_Tool, but we only push to here after a successful deploy to production

Active Dev Link: http://expert-review-tool-dev.s3-website-us-east-1.amazonaws.com/src/index.htm#v=login

  • Due to required login, you must actively push your changes to dev site while coding to see your changes properly (see Build/Deploy Processes below)

Staging Link: http://expert-review-tool-staging.s3.amazonaws.com/src/index.htm#v=login

Prod Link: https://expert-review-tool.s3.amazonaws.com/index.htm#v=login

Working locally to implement or debug the app

  • Install apache on your laptop and go to localhost/~{yourMacName}

Login info

  • Login to ERT from any of the staging environments (dev, staging, etc.) requires you to login using blueraster and Raster2017!

Build/Deploy Processes

  • npm install: Doesn't work too well in this repo. but manually installing the modules works
  • gulp dist: Run this task before deploying to staging or production to minify code and strip out console logs

The following gulp aws-* tasks assume you have an AWS profile called emammal

  • MAKE SURE YOU HAVE EMAMMAL AWS KEYS AND AN AWS profile called emammalBEFORE YOU DO ANYTHING
  • To make an AWS named profile, please refer to http://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html
  • gulp aws-dev: Due to required login, you must actively push your changes to dev site while coding to see your changes properly. A good TODO would be to couple this gulp task with a watch task to auto deploy to dev site
  • gulp dist + gulp aws-staging: Deploys to staging site
  • gulp dist + gulp aws-prod: Deploys to prod site

Additional Notes

  • If you need to make a UI change, all of that occurs in the index.htm file. The views are all in this file, separated by their view ids
  • If you need to make a functionality change, that logic can be found in the js folder with the corresponding name of a view (e.g. the logic for the dashboard view will be in the dashboard folder)
  • If you change the architecture of a model, make sure you make those changes in both the constructor() AND the update() functions of that model
  • This app heavily relies on dijits, so if it seems like a button is disabled when it should be enabled, it is actually a quick fix. All you have to do is reference the dijit and change that property accordingly