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

Adding docker tools and instructions for client side devs #854

Merged
merged 2 commits into from
Dec 4, 2020

Conversation

mattyweb
Copy link
Collaborator

@mattyweb mattyweb commented Dec 3, 2020

Includes a README and shell script to set up a local 311 Server.
All you need is to have Docker installed.

@mattyweb mattyweb requested a review from adamkendis December 3, 2020 03:23
@mattyweb
Copy link
Collaborator Author

mattyweb commented Dec 3, 2020

Would be great to get a review from a frontend team member. Hoping to make this as easy as possible.

One outcome of this process is that we could destroy the dev environment and only stand that up when we needed to do testing as a group.

Copy link
Member

@adamkendis adamkendis left a comment

Choose a reason for hiding this comment

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

Hey Matt, just tried this out. Worked perfectly after deleting old docker containers with conflicting names - won't be a problem for new devs. A few small things that might make this better for any new-to-docker devs:

  1. Live tail the logs from the 311-api container so devs can see the server running without checking running docker containers.
  2. Instructions or a script to stop the api and cleanup containers so they aren't running forever in the background.

Other than that, this was super quick and simple. Tested calls from the docs.


The 4 included images will need about 1 GB of space with an additional 1 GB or so needed for the data.

## Initialization Script
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about swapping the positions of Initialization Script and Installation Instructions sections? Devs (me) who don't read through the whole README first will see instructions first then an explanation of what the init script does.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was confused if i had to create the Initialization script myself. Would be good to just have the install instructions to make it simpler but otherwise everything works when executing the bash script. Awesome work!

Making changes to the doc and merging to get code on dev.
@mattyweb mattyweb merged commit 753c19e into dev Dec 4, 2020
@mattyweb mattyweb deleted the feat-docker-for-client branch December 4, 2020 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants