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

[DOCS] Development environment setup #16

Open
jerdra opened this issue Nov 18, 2021 · 1 comment
Open

[DOCS] Development environment setup #16

jerdra opened this issue Nov 18, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jerdra
Copy link
Contributor

jerdra commented Nov 18, 2021

Development environment setup for airflow is tricky because it requires a back-end database and some data + services be available in order to test in the development environment. Setting up a DEV environment therefore requires documentation so that contributors can get up to speed quickly with minimal configuration and setup.

For details see #17

@jerdra jerdra added the documentation Improvements or additions to documentation label Nov 18, 2021
@jerdra jerdra changed the title [DOCS] CI/CD descriptions as well as development environment setup [DOCS] Development environment setup Nov 18, 2021
@jerdra jerdra self-assigned this Nov 19, 2021
@jerdra
Copy link
Contributor Author

jerdra commented Nov 19, 2021

ok so I've done a bit of reading + thinking on this topic and I'm leaning towards implementing our DEV environment in a completely separate repo. I like the approach here:

https://www.numeratorengineering.com/microservice-dev-environments/

In summary, applying the above:

  • We'd keep airtigrs-docker-compose as a separate repository for spinning up development environments
  • Extensions (i.e dashboard, airtigrs, xnat, sftp, redcap) will be implemented as submodules containing a Dockerfile
  • I'm still learning/figuring out whether it's better to have a single docker-compose vs. multiple docker-compose..yml files. I'm leaning toward the latter since our separate services aren't actually tightly coupled and can be configured using our central main_config.yaml file anyway

Also moving forward, what do ppl think about porting over all discussion surrounding development environments to https://github.com/tigrlab/airtigrs-docker-compose?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant