Additionally this PR edits README.md to reference this setup file and includes docker files in .gitignore.
Important thing to note is that this PR removes POSTGRES_PRISMA_URL env variable. I explain why in the "Discussion" section of this PR.
Benefits
Benefits of this PR are discussed in detail in #29. Adding a setup wizard makes it easy for new outside developers to hop into the project. This makes the project more accessible therefore might increase the amount of contributors to this open source project.
Discussion
As I was working on the script file I noticed that there is a POSTGRES_PRISMA_URL env variable among the others. Is there any reason it is there? There is no use of this variable as of now in the codebase and since Drizzle is used as the ORM I doubt there is a need for Prisma as an additional ORM.
Omitting Prisma makes the setup easier. Of course I can add Prisma back if needed.
Let me know if you need anything changed or adjusted. :)
Sorry for one big commit instead of a few smaller ones, forgot to commit ahead. Will do next time.
Description
This PR adds script.ts that is a setup wizard for a local dev environment. It is based on https://github.com/leerob/next-saas-starter/blob/main/lib/db/setup.ts and can be run using command
pnpm run setup
.Additionally this PR edits README.md to reference this setup file and includes docker files in .gitignore.
Important thing to note is that this PR removes
POSTGRES_PRISMA_URL
env variable. I explain why in the "Discussion" section of this PR.Benefits
Benefits of this PR are discussed in detail in #29. Adding a setup wizard makes it easy for new outside developers to hop into the project. This makes the project more accessible therefore might increase the amount of contributors to this open source project.
Discussion
As I was working on the
script
file I noticed that there is aPOSTGRES_PRISMA_URL
env variable among the others. Is there any reason it is there? There is no use of this variable as of now in the codebase and since Drizzle is used as the ORM I doubt there is a need for Prisma as an additional ORM.Omitting Prisma makes the setup easier. Of course I can add Prisma back if needed.
Let me know if you need anything changed or adjusted. :)
Sorry for one big commit instead of a few smaller ones, forgot to commit ahead. Will do next time.