Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker files and update README #50

Merged
merged 3 commits into from
Oct 29, 2017
Merged

Add docker files and update README #50

merged 3 commits into from
Oct 29, 2017

Conversation

NdagiStanley
Copy link
Contributor

What does this PR do?

Fixes #46

Description of Task to be completed?

Add docker files and updates the Readme to give instruction on how to run it.

How should this be manually tested?

As outlined in the README:

  1. Install docker
  2. Run docker-compose up

Note:

I have one line, in the run.sh, what I deem to be the default command for each docker-compose run.

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 27, 2017
@SendGridDX
Copy link

SendGridDX commented Oct 27, 2017

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ NdagiStanley
❌ mbernier
You have signed the CLA already but the status is still pending? Let us recheck it.

README.md Outdated
> Steps

1. Install Docker
2. Run `docker-compose up` (This runs tests by default)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there should be a docker-compose build step as #2, can you please add that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I LOVE that the build runs the tests. That's awesome.
It would be cool to make a note in the README about changing the run.sh file to another script if they want to run that.

@mbernier
Copy link
Contributor

THIS IS AWESOME, btw.

@mbernier mbernier added difficulty: hard fix is hard in difficulty hacktoberfest labels Oct 28, 2017
@mbernier mbernier merged commit 9d94522 into sendgrid:master Oct 29, 2017
@thinkingserious
Copy link
Contributor

Hello @NdagiStanley,

Thanks again for the PR!

We want to show our appreciation by sending you some swag. Could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

thinkingserious pushed a commit that referenced this pull request May 22, 2018
Add docker files and update README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: hard fix is hard in difficulty status: code review request requesting a community code review or review from Twilio
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants