Fix dev onboarding installation instructions #590
Labels
feature: Onboarding
PBV: dev
all issues for engineering roles (devops, backend, frontend, db)
role: backend
Pertains to backend tasks
role: frontend
Pertains to frontend tasks
size: 2pt
Can be done in 7-12 hours
Milestone
Overview
As a new developer joining the team, I should be able to set up a development environment on my computer without much trouble.
When assisting Roja set up the development environment on her local machine, I came across some issues that should ideally be resolved to make it easier for future devs to start coding.
Issues:
docker compose up
doesn't work out of box. We need to use thedocker-compose.dev.yml
file which can be confusing and unclear for new developers joining the project.--watch
flag didnt work at firstSteps should simply be:
dev.env
filedocker compose up --watch
I'd like for it to be as easy as possible for new devs to get started working on the project.
Action Items
docker-compose.dev.yml
with the originaldocker-compose.yml
filedocker compose up
command that worksAfter the above is done:
main
anddevelop
and how they work.ISSUE_TEMPLATE/dev_onboarding.md
). (Warning: at the momemnt, this file is only in themain
branch. It is not in thedevelopment
branch)Resources/Instructions
https://hackforla.github.io/CivicTechJobs/developer/installation/
The text was updated successfully, but these errors were encountered: