Summary
Setting up the project locally currently requires multiple manual steps—such as installing workspace dependencies, generating the Prisma client, and running database migrations—which can lead to configuration errors across different operating systems. This feature proposes creating 3 dedicated interactive setup scripts tailored for each OS (setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS). Instead of automatically creating .env files, each script will interactively prompt and remind the user of the minimum required .env variables, verify their input, and then automatically handle dependency installation and database initialization for a seamless, error-free onboarding experience.
Problem
The README.md setup instructions are currently unevenly structured and confusing for new contributors, requiring multiple manual steps to install workspace dependencies, generate Prisma clients, run database migrations, and configure environment variables across different operating systems. To solve this, this feature proposes creating 3 dedicated interactive setup scripts tailored for each OS (setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS).
Proposed Solution
We propose introducing 3 dedicated interactive setup scripts tailored for each OS: setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS. Rather than automatically creating .env files, each script will interactively guide and remind the developer of the mandatory .env variables, prompt them to input/confirm required values, and then automatically run pnpm install, Prisma generation (pnpm exec prisma generate), and initial database setup. Additionally, the README.md will be updated with clear, streamlined setup commands for each operating system to eliminate onboarding confusion.
Alternatives Considered
We considered relying solely on detailed manual setup steps in the README.md, but this would still be prone to human error during setup execution. We also evaluated a single cross-platform Node.js setup runner (node setup.js), but dedicated OS-native scripts (.ps1 and .sh) offer better native shell integration and environment verification before Node dependencies are initialized. Finally, we considered automatically copying .env templates, but an interactive prompt was chosen instead to ensure developers actively review and provide their required environment variables rather than running the app with invalid placeholders.
Additional Context
Summary
Setting up the project locally currently requires multiple manual steps—such as installing workspace dependencies, generating the Prisma client, and running database migrations—which can lead to configuration errors across different operating systems. This feature proposes creating 3 dedicated interactive setup scripts tailored for each OS (setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS). Instead of automatically creating .env files, each script will interactively prompt and remind the user of the minimum required .env variables, verify their input, and then automatically handle dependency installation and database initialization for a seamless, error-free onboarding experience.
Problem
The README.md setup instructions are currently unevenly structured and confusing for new contributors, requiring multiple manual steps to install workspace dependencies, generate Prisma clients, run database migrations, and configure environment variables across different operating systems. To solve this, this feature proposes creating 3 dedicated interactive setup scripts tailored for each OS (setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS).
Proposed Solution
We propose introducing 3 dedicated interactive setup scripts tailored for each OS: setup-windows.ps1 for Windows, setup-linux.sh for Linux, and setup-mac.sh for macOS. Rather than automatically creating .env files, each script will interactively guide and remind the developer of the mandatory .env variables, prompt them to input/confirm required values, and then automatically run pnpm install, Prisma generation (pnpm exec prisma generate), and initial database setup. Additionally, the README.md will be updated with clear, streamlined setup commands for each operating system to eliminate onboarding confusion.
Alternatives Considered
We considered relying solely on detailed manual setup steps in the README.md, but this would still be prone to human error during setup execution. We also evaluated a single cross-platform Node.js setup runner (node setup.js), but dedicated OS-native scripts (.ps1 and .sh) offer better native shell integration and environment verification before Node dependencies are initialized. Finally, we considered automatically copying .env templates, but an interactive prompt was chosen instead to ensure developers actively review and provide their required environment variables rather than running the app with invalid placeholders.
Additional Context