Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Lesson: Environment Variables #27907

Open
2 tasks
01zulfi opened this issue May 1, 2024 · 6 comments
Open
2 tasks

New Lesson: Environment Variables #27907

01zulfi opened this issue May 1, 2024 · 6 comments
Assignees
Labels
Project Node Revamp Issues/PRs related to the Node Revamp project Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues

Comments

@01zulfi
Copy link
Member

01zulfi commented May 1, 2024

Lesson: Environment Variables

Lesson overview

What and why env vars && using dotenv. This new lesson will be placed before the new Express section. The security configuration lesson will be removed as a result.

Lesson outline

The following items define the scope of the lesson. The lesson outline is flexible; you can improve, expand, and omit items whilst writing lesson content (make sure the pull request description mentions that).

  • What are environment variables and why they're useful && env vars live in Node's process.env
  • Mention that we can manually populate process.env using the export cli command
  • Mention there's a better way with the dotenv package
  • Give a simple code example of installing & using dotenv

Acceptance criteria

If the requirements here are not met, the work effort is not complete.

  • Lesson conforms to the outline above (unless outline has been modified).
  • Lesson follows our Layout Style Guide.

Additional information

Get the lesson template

Download the lesson template using the following command (replace lesson_name with the actual lesson name):

curl -o <lesson_name>.md https://raw.githubusercontent.com/TheOdinProject/curriculum/main/templates/lesson-template.md 
@01zulfi 01zulfi transferred this issue from TheOdinProject/top-meta May 1, 2024
@01zulfi 01zulfi added this to the Node Revamp: Milestone # 1 milestone May 1, 2024
@01zulfi 01zulfi added the Project Node Revamp Issues/PRs related to the Node Revamp project label May 1, 2024
@MaoShizhong
Copy link
Contributor

I'm happy to take this one. Whereabouts in the lesson order are you thinking this should be placed? Given that the Intro to Express was written with the assumption that environment variables have already been taught (though this can be amended accordingly).

@Baguirre03
Copy link
Contributor

Oops. If youre too busy could I take this one Mao :) Would love your feedback on it though!

@MaoShizhong
Copy link
Contributor

No worries at all, wasn't actually aware of the prior Discord discussion! All yours and looking forward to it! 🎉

@01zulfi
Copy link
Member Author

01zulfi commented May 1, 2024

@MaoShizhong I totally forgot about the env var mention in the Intro to Express lesson, good callout.

The env var lesson would be pretty much independent from any surrounding lessons, we could place it before the Express section altogether (updated the issue description accordingly).

@MaoShizhong
Copy link
Contributor

Yeah, prior the the Express section probably makes most sense given it's a general Node thing 👍 One step further in the milestone! 🎉

Copy link

github-actions bot commented Jun 1, 2024

This issue is stale because it has had no activity for the last 30 days.

@github-actions github-actions bot added the Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues label Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Project Node Revamp Issues/PRs related to the Node Revamp project Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues
Projects
Status: In Progress
Development

No branches or pull requests

3 participants