gregsadetsky / minimalish-django-starter

Django + Vite starter kit & easy deployment using disco
0 stars 1 forks source link

Readme(!) improvments(?) #7

Closed robsimmons closed 10 months ago

robsimmons commented 10 months ago

I footgunned myself trying to create a project because I was thinking "minimalish-django-starter" and so I was like "robs-django-starter sounds like a good project name" but no, hyphens are no good, so I'm making that text more assertive

It's easier to undo "creating something in an unnecessarily deep subdirectory" than "oh no I just started a django project in my repository home" so I added mkdir and cd instructions to the script.

Overwrite the readme containing the script with a project-specific readme as the last step in the script in the readme. The new README is a little duplicative of this one but I think that's reasonable. The project-specific readme also tries to think about someone downloading the specific project, rather than starting from the template.

robsimmons commented 10 months ago

Closes #2

robsimmons commented 10 months ago

Proved this step out with https://github.com/robsimmons/botany / https://botany.onrender.com , woof that "don't know what the host is until you deploy" thing's a bit rough but otherwise this is butterlike

gregsadetsky commented 10 months ago

AMZING!!!!!!!!!!!!!!!!!!!!!!! thank you so so so so much, will be taking a look but this is awesome

I am hopeful that the supra-bizarre render-hosts dance could be improved? maybe? there's RENDER_EXTERNAL_URL, I was secretly hoping we could use that...??

robsimmons commented 10 months ago

One thing I might add to this PR or do separately: how would you feel about trying to set up .env automatically: basically the DATABASE_URL probably wants to be postgresql://{{ whoami }}@localhost:5432/{{ project_name }} and DJANGO_SECRET_KEY probably wants to be {{ uuidgen }} and this could happen more automatically than it does

gregsadetsky commented 10 months ago

One thing I might add to this PR or do separately: how would you feel about trying to set up .env automatically: basically the DATABASE_URL probably wants to be postgresql://{{ whoami }}@localhost:5432/{{ project_name }} and DJANGO_SECRET_KEY probably wants to be {{ uuidgen }} and this could happen more automatically than it does

I am not against it -- but I do fear that whoami might... not work on Windows? and/or that the postgresql user on windows as well might be... not the user? (see these notes added by windows folks on the nycnoise project)

so maybe not for now, but potentially as a future thing?

I'd love to tackle/fix/improve the render vs allowed_hosts thing too/first.. render does offer RENDER_EXTERNAL_URL ....! should it be part of the initial ALLOWED_HOSTS....?