learn-co-curriculum / react-hooks-phase-2-project

Other
4 stars 135 forks source link

Why 2 repos? #7

Open baschenbrenner opened 1 year ago

baschenbrenner commented 1 year ago

Canvas Link

https://learning.flatironschool.com/courses/4175/pages/phase-2-project-guidelines?module_item_id=233157

Concern

Why are we telling students to create two repos here - seems like an unnecessary "requirement" that is not really a requirement at all.

Additional Context

No response

Suggested Changes

No response

somethingfly commented 12 months ago

You are absolutely right, I went through this on Discord with my Flex instructor.

Me: And you saying this sentence from https://github.com/learn-co-curriculum/react-hooks-phase-2-project is a lie / misleading / poorly phrased? "For this project, you will need two separate repositories: one for your frontend and one for your backend." Specifically we do NOT need two separate repositories to pass phase 2 project? In fact, this may be completely contradicted by this statement later "If you prefer, instead of using the template, you can create a db.json file in the root of your project with a structure that looks like this:" Because that clearly is in the same repo.

Flex instructor: " Specifically we do NOT need two separate repositories to pass phase 2 project? Correct! If you want to deploy later you could just fork the json server template then I often suggest students come back to this project after learning Rails and build out a Rails backend for the project if they would like to deploy it In fact, this may be completely contradicted by this statement later "If you prefer, instead of using the template, you can create a db.json file in the root of your project with a structure that looks like this:" Because that clearly is in the same repo. Right, that's the setup I followed in my video "

At the absolute least: "For this project, you will need two separate repositories" -> "For this project, if you plan on deploying, which is not a requirement for this Phase 2 project, then you will need two separate repositories: one for your frontend and one for your backend. However, if you do not plan on deploying, you can use a single repository, and simply create a db.json file in your frontend app as described below."

So many problems with this Github page. 1) it is not clear that deployment steps can be done much later, and they are equally/poorly described, so both this extra repo AND everything in the Deploy section. Everything that is NOT a requirement should be made clear as NOT required and can be done at a later date (and how because that would be different steps). 2) This link for creating a react site is not very useful for a student at this point: https://create-react-app.dev/docs/getting-started/ . Instead, or in addition, there should be a mention to the "optional class in Phase 2 Canvas: "Create React App". " Otherwise people will be confused about npx; they will be inundated with unnecessary information at this time about yarn, templates, typescript; and they will not know to use the "--use-npm" flag described in the optional class (and since it /is/ optional it is very easy to skip). Even better, that class should be in Github so it can be directly linked to. 3) "Then, assuming you have json-server installed globally, " should be "Then, assuming you have json-server installed globally, which you almost certainly will" . 4) There are tons of steps that really should be spelled out because students up to this point have been doing a lot of "learn test" and will need refreshers on how to create a repo, connect the repo, and commit changes.