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

Fix dev onboarding installation instructions #590

Open
8 tasks
LoTerence opened this issue Oct 1, 2024 · 1 comment
Open
8 tasks

Fix dev onboarding installation instructions #590

LoTerence opened this issue Oct 1, 2024 · 1 comment
Assignees
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

Comments

@LoTerence
Copy link
Member

LoTerence commented Oct 1, 2024

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:

  • Installation instructions documentation is outdated
  • Its annoying to fork the repo for core team. It causes obstacles for efficient collaboration
  • docker compose up doesn't work out of box. We need to use the docker-compose.dev.yml file which can be confusing and unclear for new developers joining the project.
  • building frontend static files blocks the vite development server from being served by django for some reason. This was not caused by using git checkout with the main branch.
  • docker compose up --watch flag didnt work at first

Steps should simply be:

  1. make a dev.env file
  2. run docker 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

  • merge docker-compose.dev.yml with the original docker-compose.yml file
  • There should be one docker compose up command that works
  • Investigate frontend build issue. Make sure django always serves the vite development server, even if there are static build files

After the above is done:

  • Update the dev installation instructions documentation
    • Include instructions to download the latest version of docker
    • (Maybe) include instructions to just branch from the hackforla repo instead of making your own fork if you are on the core team. Open source contributors should still fork
  • Add documentation about the two different branches: main and develop and how they work.
  • Update dev onboarding issue template with new documentation (ISSUE_TEMPLATE/dev_onboarding.md). (Warning: at the momemnt, this file is only in the main branch. It is not in the development branch)

Resources/Instructions

https://hackforla.github.io/CivicTechJobs/developer/installation/

@LoTerence LoTerence added size: 2pt Can be done in 7-12 hours feature: Onboarding PBV: dev all issues for engineering roles (devops, backend, frontend, db) labels Oct 1, 2024
@LoTerence LoTerence self-assigned this Oct 3, 2024
@nooriaali9
Copy link
Member

Hi @LoTerence the Role for this issue is missing, will you be able to update that?

@LoTerence LoTerence added role: backend Pertains to backend tasks role: frontend Pertains to frontend tasks labels Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: 🆕 New Issue Approval
Development

No branches or pull requests

2 participants