docs: Write set-up section in README for new developers

brighthive / master-client-index

BrightHive's Master Client Index framework.

MIT License

2 stars 2 forks source link

docs: Write set-up section in README for new developers #1

Closed reginafcompton closed 5 years ago

reginafcompton commented 5 years ago

This PR adds a "Getting started" section in the README. It provides a step-by-step guide for running the app with Docker and managing dependencies with Pipenv.

@gregmundy - it looks like this repo has an MIT license (i.e., it's open source!). Do you think we should direct the README to an open-source audience? I somewhat did that, but I am not sure if you think it's necessary.

gregmundy commented 5 years ago

@reginafcompton yup, all our software is open source! 😸 Anything you can do to make it more accessible to the open source community is awesome!!

reginafcompton commented 5 years ago

Great @gregmundy! One additional question about this PR – running pipenv install updated some of the requirements, i.e., created a new Piplock. I guess that's the expected behavior, right? I just want to be sure that this PR does not cause strangeness elsewhere.

gregmundy commented 5 years ago

@reginafcompton no, it should be fine. Also forgot to mention that running pipenv install will literally only install the production dependencies. If you need to install development specific dependencies (e.g. testing and linting libraries) locally, you'll also need to run pipenv install --dev