wri / aqueduct-flood

Aqueduct Floods

Repository for WRI's Aqueduct Floods tool.

Getting Started

1. Install Docker and start it up.
2. Clone the repo: https://github.com/greenriver/aqueduct-flood
3. Be sure to set the necessary environment variables in .env.development.local. Ask an established developer for help with this step.
4. Run docker-compose up to build your image and fire up the container. Visit localhost:3030. Ctrl-C to stop.

Git Flow

1. Create all new branches by branching off develop.
2. Open pull requests against develop as well.
3. Merge branches into develop when they are ready to be deployed for testing.
4. When a change is ready to be deployed to the production website, merge develop into main.

Git Flow

1. Create all new branches by branching off develop.
2. Open pull requests against develop as well.
3. Merge branches into develop when they are ready to be deployed for testing.
4. When a change is ready to be deployed to the production website, merge develop into main.

Deployment

Deploying to staging

1. Run docker-compose run web yarn build to compile.
2. Copy the contents of the build directory to the wriorg repo.
   • Make sure you are on the aqueductgr2 branch of the wriorg repo.
   • Copy the build to the wriorg/applications/aqueduct/floods directory.
   • This command may work for you too: rsync -a build/ ../wriorg/applications/aqueduct/floods/
3. From the wriorg repo, commit and push changes to the aqueductgr2 branch. Enter your Pantheon password when/if prompted.
   • In your commit message, include the app name and the hash for the commit from that app's repo that you are deploying, for example:

     Update aqueduct-flood to commit 8df15603a5d939995b03ade0429f90434a19e6ca

   • The app is deployed on push to https://aqueductgr2-wriorg.pantheonsite.io/applications/aqueduct/floods/

Deploying to production

To deploy to production, follow the same steps as above but use the aqueduct-gr branch of the wriorg repo instead of the aqueductgr2 branch. You must then ask WRI staff to merge and promote the update to production.

Requirements

  node 10.20.1

May encounter problems upgrading because of component dependencies.

Data and scripts

• Cost Benefit Analysis Python script: https://github.com/greenriver/aqueduct-analysis-microservice
• Floods widget data accessible through resourcewatch API
• Raster data in Google Earth Engine, accessible through resourcewatch API

Working with AQ-components

---

AQ-components provides a bunch of useful components to use in the different AQ apps.

To work with it, go to your AQ-components project, and run yarn link. This will generate a symlink to the project.

Now, let's compile the code and make it responsive to changes: run yarn components:watch.

Go to your application and link the components: yarn link aqueduct-components.

You should be ready to work!

Aqueduct Repo Directory

• Aqueduct Water Risk Atlas - https://github.com/greenriver/aqueduct-water-risk
• Aqueduct Country Rankings - https://github.com/greenriver/aqueduct-countries-ranking
• Aqueduct Food - https://github.com/greenriver/aqueduct-food
• Aqueduct Floods - https://github.com/greenriver/aqueduct-flood
• Aqueduct Components - https://github.com/greenriver/aqueduct-components