search

CodeYourFuture / syllabus

Old Syllabus Website for CodeYourFuture
https://syllabus.codeyourfuture.io
154 stars 123 forks source link

Add require, file paths & NPM to JS-3 Week 3 #218

Open 40thieves opened 3 years ago

40thieves commented 3 years ago

Which module(s) and week(s) does this change effect? Module(s): JS3 Week(s): 3

What is the work that needs to be done?

Add lesson content to show how to use the require function and packages from NPM. This would also include some content about file paths (including relative paths with ./).

We could consider reworking some of the content in https://github.com/CodeYourFuture/syllabus/pull/189, as it includes interaction with a simple (and fun!) NPM package, which trainees could then recreate to learn about require.

Why is this work important to do?

There have been some recent discussions about when we teach these important aspects of JS.

In this thread: https://github.com/CodeYourFuture/syllabus/pull/166#issuecomment-770410775, it was pointed out that we don't teach anything about the require function (and import) or interact with NPM packages until the React module.

Additionally, in this thread: https://github.com/CodeYourFuture/syllabus/pull/166#issuecomment-770410775, we discussed how file paths in the context of JS are often forgotten about, but are quite important in modern apps. Similar to the point above, currently we do not teach about file paths (in JS) until the React module.

There are 2 problems with this:

  1. Paths, require/import and NPM are very useful outside the React module, so we should teach them separately
  2. The first week of React is already fairly packed with content, so there is not much time to practice the concepts

Additional context

This was discussed at the syllabus team meeting on 2021-03-17.

Who might need to know about this change?

@ChrisOwen101 @SallyMcGrath @illicitonion

SallyMcGrath commented 3 years ago

ALSO I think we can introduce the concept of components in HTML/CSS and then keep calling back to it and therefore not have to do ALL that in w1 of react

40thieves commented 3 years ago

we can introduce the concept of components in HTML/CSS

This feels a bit off-topic for this thread? But I do definitely agree, I often start the React week 1 by talking about Bootstrap components. And I have to remind myself to move quickly through that, as week 1 is by far the tightest time-wise.

40thieves commented 3 years ago

PR is up (finally) https://github.com/CodeYourFuture/syllabus/pull/324