CodeForPhilly/balancer-main

Add convenience methods for backend development

Closed this issue · 0 comments

Depends on #15

A user should be able to run common shell environments and django commands via make commands

Purpose: TLDR of why we need this?

A developer should not need to be a docker expert in order to work on the backend. We can hide the complexity of docker using make commands.

  • creating a superuser: make create-superuser
  • make migrations: make migrations
  • migrate: make migrate
  • run unit tests: make run-unit-tests
  • run functional tests: make run-functional-tests
  • launch shell: make launch-shell-plus

etc ...

Description

Is your feature request related to a problem? Please describe.
Most of the team is not familiar with docker. We don't want devsops related knowledge to get prevent developers from working with us. Make commands can be run without understanding or negative side-effects (besides us needing to maintain them).

Functionality: TLDR of what will this change?

Description

This will make it much easier to onboard new developers.

Pros/Cons

We're trading off convenience for obfuscation. Anyone trying to understand how all our code works will have an additional layer in the form of Makefile. Still, there is no requirement to use the make commands.

Additional context

Sometimes details are overrated