Add some Quality of Life improvements

[ciaransweet]

What I am changing

TL;DR:

This PR adds some Quality of Life improvements to the repository, namely pinning versions and making overall interaction with the project a bit easier

Closes #13 #12

How I did it

Dependencies

• Pinned dependency versions in both Pipfile and package-lock.json
• Add Makefile commands to abstract installation of 'prod' vs 'dev' dependencies

CDK

• Moved all CDK related code into cdk/ so that we're explicitly keeping it in one location and not the root and another directory

General

• Add a more verbose and wider-ranging .gitignore
• Align Makefile to match the more recent style I've used in pangeo-forge-aws-bakery
• Add make ssh-to-instance to abstract out ssh'ing logic
• Update README.md:
  • Add build status badge
  • Update pre-requisites to match pangeo-forge-aws-bakerys style
  • Update Makefile section
  • Add some links in the .env table
  • Extract the example .env file out to example.env

Github

• Add basic Github Actions workflow
• Add PR template

How you can test it

No real functional changes as such, a CI build should happen which should pass on linting.

Otherwise you can re-run through the instructions and see that the deployment still functions.

Note:

I do intend on adding some unit tests for the utils code eventually.

[wildintellect]

Makes me realize at some point we might need to package this so it's a utility that can be installed and/or run on a per repo/project basis.

I'm still a little confused with this change, if someone deploys, ssh, starts some code, disconnects, and then wants to come back later to check on the instance, how they remember which instance to ssh to?

[ciaransweet]

Makes me realize at some point we might need to package this so it's a utility that can be installed and/or run on a per repo/project basis.

I'm still a little confused with this change, if someone deploys, ssh, starts some code, disconnects, and then wants to come back later to check on the instance, how they remember which instance to ssh to?

@wildintellect not sure what you're implying with this? What would be packaged as a utility?

[ciaransweet]

Also @wildintellect if something doesn't make sense, you're welcome to reject the PR haha!