Skip to content

Commit 16e36bb

Browse files
committed
added to set-up documentation fall2025 update
1 parent 6dc3abc commit 16e36bb

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ SMTP_HOST=
1515
SMTP_PORT=
1616
SMTP_USER=
1717
SMTP_PASS=
18-
SMTP_FROM_NAME=
19-
SMTP_FROM_EMAIL=
18+
SMTP_FROM_NAME=Kids-U
19+
SMTP_FROM_EMAIL=noreply@kidsU.com

docs/setUPProjectV2.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@
2929

3030
- In VSCode, create a new .env file at the project repository root
3131
- Copy the text from the .env.example file and paste into the .env file
32+
- Generate JWT Token & paste into env: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
3233
- Change the `PORT` to 5432, `USER`, `PASSWORD` and `DATABASE` to kidsu
34+
- Create Mailtrap account, paste from sandbox `HOST`,`PORT`, `USER`, and `PASS`
3335
- In the VSCode terminal, run `npm install`
3436
- Open the docker application, then in the VSCode terminal, run `docker compose up -d`
3537
- Don't register/login to Docker, just press skip

docs/techstack.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,21 @@ This project utilizses JavaScript/TypeScript, HTML, and CSS.
4444
- [CSS Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS)
4545
- [JavaScript Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
4646
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
47+
48+
## Libraries/DevTools
49+
50+
## jose
51+
A modern library for signing and verifying JSON Web Tokens (JWT). We use this instead of jsonwebtoken because jose is compatible with the Next.js Edge Runtime (Middleware).
52+
[jose Documentation](https://github.com/panva/jose)
53+
- Used primarily in middleware.ts to validate user sessions and protect routes.
54+
55+
## Nodemailer
56+
A module for Node.js applications to allow easy email sending. It acts as the "transport" mechanism to deliver 2FA codes and password reset links.
57+
[Nodemailer Documentation](https://nodemailer.com/)
58+
- This requires an SMTP configuration (host, port, user, pass) to function.
59+
60+
## MailTrap
61+
Mailtrap is a fake SMTP server used for testing and development. It "traps" emails sent by Nodemailer so they don't go to real email addresses, allowing developers to inspect the content safely.
62+
[MailTrap Documentation](https://mailtrap.io/fake-smtp-server/)
63+
- Login to Mailtrap and copy the SMTP credentials into your .env file.
64+
- When you send an email in development, check your Mailtrap Inbox to view the rendered HTML and verify the 2FA code.

0 commit comments

Comments
 (0)