[Backend] NodeJS - week 1

[marcorichetta]

Description

• Based on Create Node.js module #58

Status

• Moved content from legacy Nodejs week 2/3 => Backend/Nodejs week 1/2

Content check or update

• Week 1

  • README
  • Learning goals
  • Preparation
  • Session-plan
    • Move teacher code to module-materials
    • Session outline -> link reading and excercises together
    • Time the session parts
    • Update the SQL related bits from MySQL to Sqlite
  • Assignment

• Week 2 -> Work moved to [Backend] NodeJS - week 2 #199

• Generic

• Review for traces of MySQL

• Review assignments for outdated material

• Remove teach-live-coding references

• Remove homework upload references

• Remove nodemon references

• (Optional) Review relevance to Foundation/intro-to-nodejs, link overlapping material if exists

Proposal overview

https://github.com/HackYourFuture-CPH/programme/blob/main/contributing/proposals/js-node-restructure.md#backend-specialisation

[magdazelena]

some comments based on my discovery with #159 and past experiences.

I like the structure though, especially in the session materials!

[adamblanchard]

@marcorichetta to review the progress here and summarise what's left, before we continue

[marcorichetta]

Candidate for preparation.md

[marcorichetta]

This made sense for MySQL. Knex with sqlite doesn't accept that config.

We should review how to replicate or change the way of showing an SQL injection. There's something similar in the backend/databases module

[marcorichetta]

@marcorichetta to review the progress here and summarise what's left, before we continue

Done!

• I updated the files I reviewed on the description of this PR
• I also left comments on the things I saw need some changes. Not to say there aren't more things to do.
• Both READMEs are mostly good but have some TODOs left

[magdazelena]

@adamblanchard I have two doubts to clear. I went according to the plan: https://github.com/HackYourFuture-CPH/program/blob/fe5da8a4eef91d759ed80b31d9d7b1bcd8be5d83/contributing/proposals/js-node-restructure.md

1. I moved POST to week 2, as per plan. The POST is, however, covered in the foundation backend module. I did not remove the POST references from the assignment yet, so I can either do that or bring the POST back to this module :)

2. Authentication is very much neglected in this module. I added a little note on "explain authentication", but it is such a vast and important topic that I wonder if it should not be better covered - is that a part of later modules? The example in the materials is also quite simplistic, which is great for begginers but perhaps an explanation would be a plus here. But idk, I tend to overexplain in the materials, so perhaps it is fine to leave it as is :D hence the question

I think I'm most doubtful about the above two, otherwise the week 1 could be up for review :)

[adamblanchard]

@magdazelena Hey! I think POST can live in week2. Since this week seems like the main focus is learning express, that makes sense.

Thought about assignment: I think it could be ok to leave POST there? They did cover POST previously, and I think assignments should not only practice what they learned in the session but also stretch them to apply things they know in new ways. We could help by linking to some documentation, or writing some more hints in the assignment. What do you think?

I can't really judge whether auth should be covered more. I do appreciate it's an important and big topic though, that is easy to "not understand". Also recognise it's one of those topics that can come up in interviews. If you think we could spend more time on it, we could move the postman stuff all to week2? Then it's more unified with the other POSTMAN stuff we are covering there, rather than splitting their focus for the last 30 mins here. And we'd have some more time here to dive into it?

Either way, might be a good idea to move postman all to week2 anyway?

I will review the rest of the PR in the meantime :)

[magdazelena]

@adamblanchard I think since we do mention auth already in the module, it could make sense to make it more extensive... I think it will depend on the mentor, but in general at least a mention of different methods could be beneficial here - and then moving POST and Postman to week 2.

I agree with the assignment, it has been already explained after all :)

[adamblanchard]

Merging this for now, this PR appears to be complete. It's also getting a bit big! Work will continue in #199