node-girls / node-workshop Goto Github PK

As discussed here I proposed the following changes :

• Fix typos.
• adding links to keyword section
• adding more illustration for some points to be more clear.

Is it ok for me to make a pull request to fix these points?

At l.29 it could be useful to remind the reader that they'll need to create a way to listen out for the specific url of the form (i.e. a new else if statement).

Not sure why that is but many of us lost it at that stage when merging. Might be better to include it also in subsequent steps and not just step 5? I'm not sure how Git deals with merging when files are deleted.

Hey, I've been trying to follow this workshop but am visiting family and don't have the luxury of a mentor/study-buddy. I think that this workshop could be much improved for independent learning by including what the server.js file contains at the end of the 5th and 6th Stages.

I've got to Stage 5/6 but I can't make sense of what's going on as I don't think my code matches what the workshop is doing at the moment.

Do you think we need to break step 10 into 2 steps : saving data in step10, retrieving data step11 and a bit of explanation on frontend side?

Create branches with relevant code/files

From points raised from Founders and Coders students whilst doing this workshop (documented in foundersandcoders/master-reference#781) we would like to change the name of the handler/handler.js function/file to router/router.js.

The reasoning would be that this function is what handles the routing of the request (via the if(endpoint === "/") etc block). The logic for actually handling each request (serving resources etc) can be abstracted into separate functions, but the function directly passed to http.createServer always has to deal with routing.

The work needed for this would be to change all references to the handler function or the handler.js file to router or router.js respectively.

Do we need to add link to workshop-cms-complete at the bottom of the readme?

Add links to keywords on each steps.

Should we add some links to good tutorials about error handling in Node.js?

Proposition:

• Add examples how to modularise project structure
• Add links to our previous workshop from November
• Reformat
• Add references where to go next
• Add best practise example: 'use strict' etc

Proposition of reformat:

• add node-girls logo
• reformat into what, why and how
• add explanation that this tutorial is very basic for the sake of simplicity
• add bits about stretch goals readme (best practise structure)
• add references to where find more useful tutorials (linked our node-girls tutorials)
• add reference to cheatsheet
• add maybe steps how to install node?

(but it is referenced in the index.html)

In week 7, we found that it is difficult for people to find the authoritative documentation on request objects, as they are described in the node docs as message or IncomingMessage (which is a type which could be either ClientRequest or ServerResponse )
Proposal:
In 'What is a handler function?' in Step 3, include:

(request and response are instances of the two different types of IncomingMessage object)

Step 5 claims that there is a link tag in index.html but there isn't one. Happy to make a pr for this

• explain in more detail about what steps they need to take , what they need to be aware, hints