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

Explicitly mention that developer should create a new .env.server file, and not use .env.server.example #51

Closed
matijaSos opened this issue Feb 21, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@matijaSos
Copy link
Collaborator

Is that the idea, did I get it right? I got across this at https://docs.opensaas.sh/guides/authentication/#google-auth, where it is mentioned to add stuff to .env.server file, but we never created it in the first place. So I wasn't sure if I should create a new one, reuse the example one or sth else. Would be nice to have some tip about this.

@matijaSos matijaSos added the documentation Improvements or additions to documentation label Feb 21, 2024
@GavPierce
Copy link

I believe it is mentioned in the Docs -> Getting started:
image

@vincanger
Copy link
Collaborator

yep! thanks @GavPierce 🙏

is that enough @matijaSos or do you think the instructions could be improved somehow?

@Martinsos
Copy link
Member

Martinsos commented Feb 28, 2024

What I did in wasp new is actually added a command to do it:

cp .env.server.example .env.server

I would consider doing that. I know for me, when reading docs, most of my focus goes on code to copy and execute :D, and less on text, and this way you make it really easy for me to do the right thing. I would keep the text, and just add this after it.

Oh and this can be mv if you want, but I actually liked copying better, because it is useful to have .env.server.example there if another teammate checks out the project. Yeah, I would advise copying, not moving.

@vincanger
Copy link
Collaborator

cool. I will add this to the docs now @Martinsos!

I think i'll close this issue for now then as it seems we've covered it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants