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

docs: add notes about env vars #869

Merged
merged 4 commits into from
Nov 27, 2022
Merged

docs: add notes about env vars #869

merged 4 commits into from
Nov 27, 2022

Conversation

meech-ward
Copy link
Contributor

@meech-ward meech-ward commented Nov 25, 2022

Closes #304

✅ Checklist

  • I have followed every step in the contributing guide (updated 2022-10-06).
  • The PR title follows the convention we established conventional-commit
  • I performed a functional test on my final commit

Changelog

Add a note about opinions surrounding .env files and the reason for the departure from next's oppinions.

@changeset-bot
Copy link

changeset-bot bot commented Nov 25, 2022

🦋 Changeset detected

Latest commit: b83762c

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Nov 25, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
create-t3-app ✅ Ready (Inspect) Visit Preview Nov 27, 2022 at 5:00AM (UTC)

@github-actions github-actions bot added 📌 area: cli Relates to the CLI 📌 area: t3-app Relates to the generated T3 App 📚 documentation Improvements or additions to documentation labels Nov 25, 2022
cli/README.md Outdated Show resolved Hide resolved
cli/README.md Outdated Show resolved Hide resolved
cli/README.md Outdated Show resolved Hide resolved
Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion the comment on gitignore is fine, but please not in t3 axioms. I suggest you add it in our env variables docs

@t3dotgg
Copy link
Member

t3dotgg commented Nov 25, 2022

Tbh thinking this is important enough to be an axiom is kinda hilarious to me

@github-actions github-actions bot removed 📌 area: t3-app Relates to the generated T3 App 📌 area: cli Relates to the CLI labels Nov 26, 2022
@meech-ward
Copy link
Contributor Author

Thank you, I occasionally try to be hilarious

@github-actions
Copy link
Contributor

github-actions bot commented Nov 26, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟢 Performance 100
🟢 Accessibility 100
🟢 Best practices 100
🟠 SEO 86
🟠 PWA 54

Lighthouse ran on https://create-t3-app-git-fork-meech-ward-next-t3-oss.vercel.app/

Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good now remove it from the T3 axioms and we can merge

@meech-ward
Copy link
Contributor Author

I did, the only change exists in www/src/pages/en/usage/env-variables.md

Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry missed that. Looks good to me!

@nexxeln
Copy link
Member

nexxeln commented Nov 26, 2022

Actually we can also add a comment in the env file with a link to our env docs

Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@nexxeln nexxeln merged commit cd93b98 into t3-oss:next Nov 27, 2022
devvianto605 pushed a commit to devvianto605/create-devviantex-nextjs-app that referenced this pull request Jun 9, 2024
* docs: add notes about env vars

* Add note about not comitting env files

* Create early-coats-stare.md

Co-authored-by: Shoubhit Dash <shoubhit2005@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📌 area: cli Relates to the CLI 📌 area: t3-app Relates to the generated T3 App 📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add min(1) on schema and reference to the docs for NEXTAUTH_SECRET on .env.example
6 participants