open-saas icon indicating copy to clipboard operation
open-saas copied to clipboard

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

Open matijaSos opened this issue 1 year ago • 3 comments

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 avatar Feb 21 '24 14:02 matijaSos

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

GavPierce avatar Feb 21 '24 15:02 GavPierce

yep! thanks @GavPierce 🙏

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

vincanger avatar Feb 28 '24 13:02 vincanger

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.

Martinsos avatar Feb 28 '24 15:02 Martinsos

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.

vincanger avatar Feb 29 '24 09:02 vincanger