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: Refactor install docs a bit #975

Open
stephenh opened this issue Mar 16, 2024 · 0 comments
Open

docs: Refactor install docs a bit #975

stephenh opened this issue Mar 16, 2024 · 0 comments

Comments

@stephenh
Copy link
Collaborator

stephenh commented Mar 16, 2024

I.e. pull out the database setup into an optional/appendix, and just assume user's have a db setup.

Feedback:


I didn’t use docker compose for my db. obv not required and makes setup seem harder than it is. I’d move it somewhere to keep the install process much more straight forward.

relatedly, I’d have the raw setup steps instead of a sample app. i.e. run npm init then npm i .. .

the “Installation” docs start with setting up docker, then setting up migration. before finally the first joist install. I think you want to start with joist and have the smallest steps to getting people writing joist code. could be more like: “run npm i joist…“, “we assume you have a postgres db so cut and paste this table schema into psql”, “run this to code gen the entities”, “write your first query”…

In my mind the next questions were: “how do I insert data” and “how do I query it”. I think providing some immediate examples of super simple CRUD operations would be good.

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

No branches or pull requests

1 participant