-
Notifications
You must be signed in to change notification settings - Fork 849
feat: add docs for npx create-db #7029
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
Conversation
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
Latest commit: |
6667fe7
|
Status: | ✅ Deploy successful! |
Preview URL: | https://0ce5a456.docs-51g.pages.dev |
Branch Preview URL: | https://dc-4164.docs-51g.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks great Ankur, well done 👏 I made a few small suggestions for your consideration 🙌
To **bootstrap a new Prisma ORM project with a Prisma Postgres database**, run the following command in your terminal: | ||
|
||
```terminal | ||
npx prisma init --db | ||
``` | ||
|
||
Once you ran this command, the terminal will output instructions for you to [follow the steps on this page](/getting-started/prisma-postgres/from-the-cli) in order to set up your first project with Prisma Postgres. | ||
After running this command, the terminal will guide you with next steps. Follow [this page](/getting-started/prisma-postgres/from-the-cli) to complete the setup for your first Prisma Postgres project. | ||
|
||
If you only need a **Prisma Postgres connection string** (without creating a full project), use: | ||
|
||
```terminal | ||
npx create-db@latest | ||
``` | ||
|
||
You can learn more about `npx create-db` in [the dedicated documentation](/postgres/introduction/npx-create-db). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would separate these two more clearly, probably by putting a heading above each.
I think right now it's too easy to think that users should run these two commands sequentially but that's not the case. (I know from myself that when I click on "Getting started" buttons, I often just skim for the "actions" I should take and copy/paste without reading much. If I did that, I'd run both commands).
Maybe smth like:
## Option A: Set up Prisma Postgres with Prisma ORM
... init --db
## Option B: Only create a Prisma Postgres DB (no auth required)
... create-db
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
Co-authored-by: Nikolas <nikolas.burk@gmail.com>
* feat: add docs for npx create-db * Update content/200-orm/500-reference/200-prisma-cli-reference.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/200-orm/500-reference/200-prisma-cli-reference.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/200-orm/500-reference/200-prisma-cli-reference.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/200-orm/500-reference/200-prisma-cli-reference.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/250-postgres/100-introduction/220-npx-create-db.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/250-postgres/100-introduction/220-npx-create-db.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/250-postgres/100-introduction/220-npx-create-db.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * Update content/250-postgres/100-introduction/220-npx-create-db.mdx Co-authored-by: Nikolas <nikolas.burk@gmail.com> * added note to getting started` --------- Co-authored-by: Marc Hess <marc@marchess.dev> Co-authored-by: Nikolas <nikolas.burk@gmail.com>
No description provided.