Node revamp: PostgreSQL lessons #27960

01zulfi · 2024-05-11T13:33:14Z

Because

#27643

This PR

Adds installing and using PostgreSQL lessons

I've opted to separate it into two lessons as that what makes sense to me right now

Issue

Closes #27643

Additional Information

Pull Request Requirements

I have thoroughly read and understand The Odin Project curriculum contributing guide
The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
The Because section summarizes the reason for this PR
The This PR section has a bullet point list describing the changes in this PR
If this PR addresses an open issue, it is linked in the Issue section
If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
If any lesson files are included in this PR, they follow the Layout Style Guide

MaoShizhong

For installing_postgresql.md

nodeJS/express/installing_postgresql.md

Co-authored-by: MaoShizhong <[email protected]>

MaoShizhong

Absolute 🔥

For using_postgresql.md:
Mainly just tiny wording nits

nodeJS/express/using_postgresql.md

nodeJS/express/installing_postgresql.md

Co-authored-by: MaoShizhong <[email protected]>

MaoShizhong

🔥
I'll add my approval now, though of course we'll probably want to wait for any others to get a chance to review.

nodeJS/express/installing_postgresql.md

thatblindgeye · 2024-05-13T12:40:31Z

nodeJS/express/installing_postgresql.md

+
+<details markdown="block">
+
+<summary class="dropDown-header">Linux</summary>


@MaoShizhong From your comment on the other PR, yeah the way we're doing these details/summary elements isn't great. Right now the heading structure from an AT perspective is essentially:

Installing PostgresSQL

Step 1: Make sure the system is up to date

....other headings....

Step 1: Make sure the system is up to date

Without any context of an OS anywhere. We could put this in as is as I'm not 100% sure how best to go about it yet. We could have the actual steps be visible at all times, then in each step have a details/summary per OS, so something like the following screenshot:

Since the content of the summary element can't be given a Markdown heading (we could use HTML h3 etc, but then we need to allow that in the lint rules). But I'd have to stew on it a bit more probably.

@thatblindgeye I straight up copy pasted the existing lesson in the Rails path in to a new file in this PR. If we do intend to make these changes, might I suggest handling it in a separate PR?

@01zulfi Oh no this is definitely something we're doing in other places, I hope my comment didn't come off as saying this was an issue you introduced or anything.

But yeah, this is something that can be a followup since it is something that will affect other lessons and there's still some ruminating to do on the idea.

All good 😆

I'm suggesting to open a separate issue/PR because this issue is relevant to other installation-esque lessons as well. Anyway, I'm happy to update this PR if we do reach a consensus on how to fix this issue.

I vote separate PR to handle both this and the Rails version together once decided on the best way to handle this.
Single headings each with OS-specific dropdowns does look appealing, though IIRC @thatblindgeye, I think you mentioned accessibility issues with the current actual method of doing the dropdown itself? Since if we can find an accessible and logical alternative that also conforms to the heading issue, we'd be wanting to update any other lesson that does things like this, like any of the earlier installations lessons

Yeah this all can be a followup

thatblindgeye · 2024-05-13T12:42:23Z

nodeJS/express/installing_postgresql.md

+
+<summary class="dropDown-header">Linux</summary>
+
+### Step 1: Make sure the system is up to date


The headings in these steps would need to be increased by one level since these are subsections of the larger "Installing PostgreSQL" section. Right now it would come off as this Step 1 section being more separate from "Installing" when it really isn't.

(see above comment)

fcasibu

Really excited with this lesson! Coding along feels on point and it reads really nice, I will go through it again and maybe I can spot something else, but great job as always!

nodeJS/express/using_postgresql.md

fcasibu · 2024-05-14T03:57:15Z

nodeJS/express/using_postgresql.md

+With our initialized `Pool`, we can use the `query` method. Create a new `db/queries.js` file. Upon revising our project requirements, we understand we need two db interactions: getting all usernames and inserting a new username. Let's define these functions:
+
+```javascript
+const pool = require("./pool");


Suggested change

const pool = require("./pool");

const db = require("./pool");

I intended for this to stay as pool, but ended up using db in the code examples. Let me update to pool.

fcasibu · 2024-05-14T04:02:09Z

nodeJS/express/using_postgresql.md

+Invoke the above two functions in the specific controllers (you might have different function names etc. The important thing is to understand how the db functions are invoked):
+
+```javascript
+const db = require("../db/queries");


I've commented above that named the pool module as db should we name this as query instead

await query.getAllUsernames(); await query.insertUsername(username);

Or we can make it more modular by creating db/queries/username.js and have generic names like Username.getAll() Username.insert() but it's up to you

What do you think?

I'd rather keep it as db, though at the end of the day I really don't feel strongly towards it. I've updated the other code example., doo let me know what you prefer though after you're read that one; I'll update the lesson accordingly.

Regarding your suggestion on making it modular: I'll trust the learners to refactor as they see fit when they work on bigger projects. They already have all the knowledge they need to do Username.getAll() or however else they want to refactor.

^ adding to the above, you might've also noticed how barebones the script was compared to the version you wrote (which included utility functions etc). I'd rather have learners come up with this stuff

nodeJS/express/using_postgresql.md

Co-authored-by: Francis Casibu <[email protected]>

Co-authored-by: MaoShizhong <[email protected]>

thatblindgeye

All other comments from me above require followups.

MaoShizhong

Same - nothing further from me besides anything Nevz or anyone else wishes to bring up 🔥

01zulfi added 2 commits May 11, 2024 18:30

feat: add installing postgresql lesson

5b1c971

feat: add using postgresql lesson

716f473

01zulfi added the Project Node Revamp Issues/PRs related to the Node Revamp project label May 11, 2024

github-actions bot added the Content: NodeJS Involves the NodeJS course label May 11, 2024

01zulfi mentioned this pull request May 11, 2024

Node revamp: Using PostgreSQL lesson #27879

Closed

7 tasks

01zulfi added 2 commits May 11, 2024 18:39

chore: dodge linter && fix typos && add newline

275c0ac

feat: add lesson not on parameterization

de5f770

MaoShizhong requested changes May 11, 2024

View reviewed changes

01zulfi and others added 5 commits May 11, 2024 20:46

chore: grammar

1a75b23

Co-authored-by: MaoShizhong <[email protected]>

fix: typo

0223519

Co-authored-by: MaoShizhong <[email protected]>

fix: descriptive link text

f138545

Co-authored-by: MaoShizhong <[email protected]>

fix: descriptive link text

223bf58

Co-authored-by: MaoShizhong <[email protected]>

chore: remove unnecessary para in installing postgres lesson

5576e45

01zulfi requested a review from MaoShizhong May 11, 2024 16:16

MaoShizhong requested changes May 11, 2024

View reviewed changes

nodeJS/express/installing_postgresql.md Outdated Show resolved Hide resolved

01zulfi and others added 11 commits May 11, 2024 21:55

chore: update markdownlint-disable-next-line comment position

4dffb96

Co-authored-by: MaoShizhong <[email protected]>

fix: grammar

c2426ee

Co-authored-by: MaoShizhong <[email protected]>

fix: use double quotes in JS code snippet for consistency

64299fa

Co-authored-by: MaoShizhong <[email protected]>

chore: update verbiage

142a998

Co-authored-by: MaoShizhong <[email protected]>

chore: update verbiage

98ccab5

Co-authored-by: MaoShizhong <[email protected]>

chore: add semicolon in JS code snippet for consistency

a69c56c

Co-authored-by: MaoShizhong <[email protected]>

chore: update verbiage

13a3eca

Co-authored-by: MaoShizhong <[email protected]>

chore: grammar

e31014e

Co-authored-by: MaoShizhong <[email protected]>

fix: use placeholder in cli commands

f7a6e34

Co-authored-by: MaoShizhong <[email protected]>

chore: update KC verbiage

4be38f3

Co-authored-by: MaoShizhong <[email protected]>

fix: typo

0eda9ae

Co-authored-by: MaoShizhong <[email protected]>

01zulfi requested a review from MaoShizhong May 11, 2024 17:03

01zulfi and others added 2 commits May 11, 2024 22:07

chore: grammar

8d06037

Co-authored-by: MaoShizhong <[email protected]>

fix: wrong syntax & variable names in JS code snippet

75826b9

MaoShizhong approved these changes May 11, 2024

View reviewed changes

thatblindgeye requested changes May 13, 2024

View reviewed changes

fcasibu reviewed May 14, 2024

View reviewed changes

01zulfi and others added 6 commits May 15, 2024 06:11

chore: remove unnecessary note headings

c623c99

fix: variable name in code example

f45e692

chore: disable TOP004 rule for installing_postgresql.md

48c5e3b

fix: typo

6b20fcc

Co-authored-by: Francis Casibu <[email protected]>

fix: grammar

43bcc44

Co-authored-by: Francis Casibu <[email protected]>

chore: remove code styling in link text

392788d

Co-authored-by: Francis Casibu <[email protected]>

01zulfi requested a review from fcasibu May 15, 2024 01:26

chore: add TODO comment

dfd4126

Co-authored-by: MaoShizhong <[email protected]>

01zulfi requested review from thatblindgeye and MaoShizhong May 18, 2024 13:42

thatblindgeye approved these changes May 18, 2024

View reviewed changes

MaoShizhong approved these changes May 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node revamp: PostgreSQL lessons #27960

Node revamp: PostgreSQL lessons #27960

01zulfi commented May 11, 2024

MaoShizhong left a comment

MaoShizhong left a comment •

edited

MaoShizhong left a comment

thatblindgeye May 13, 2024

01zulfi May 15, 2024

thatblindgeye May 15, 2024

01zulfi May 15, 2024

MaoShizhong May 15, 2024

thatblindgeye May 18, 2024

thatblindgeye May 13, 2024

01zulfi May 15, 2024

fcasibu left a comment

fcasibu May 14, 2024

01zulfi May 15, 2024

fcasibu May 14, 2024 •

edited

01zulfi May 15, 2024

01zulfi May 15, 2024

thatblindgeye left a comment

MaoShizhong left a comment


		<details markdown="block">

		<summary class="dropDown-header">Linux</summary>


		<summary class="dropDown-header">Linux</summary>

		### Step 1: Make sure the system is up to date

	const pool = require("./pool");
	const db = require("./pool");

Node revamp: PostgreSQL lessons #27960

Are you sure you want to change the base?

Node revamp: PostgreSQL lessons #27960

Conversation

01zulfi commented May 11, 2024

Because

This PR

Issue

Additional Information

Pull Request Requirements

MaoShizhong left a comment

Choose a reason for hiding this comment

MaoShizhong left a comment • edited

Choose a reason for hiding this comment

MaoShizhong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcasibu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fcasibu May 14, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thatblindgeye left a comment

Choose a reason for hiding this comment

MaoShizhong left a comment

Choose a reason for hiding this comment

MaoShizhong left a comment •

edited

fcasibu May 14, 2024 •

edited