Skip to content

Conversation

@waleedlatif1
Copy link
Collaborator

Summary

update readme.md to reflect new instructions for running locally

Type of Change

  • Documentation

Testing

Tested manually.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel
Copy link

vercel bot commented Sep 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Building Building Preview Comment Sep 22, 2025 6:32pm
sim Ready Ready Preview Comment Sep 22, 2025 6:32pm

@waleedlatif1 waleedlatif1 merged commit 6fada45 into staging Sep 22, 2025
3 of 5 checks passed
@waleedlatif1 waleedlatif1 deleted the improvement/readme branch September 22, 2025 18:12
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Summary

This PR improves the manual setup instructions in the README.md file by adding explicit database package configuration steps. The change addresses a common setup issue in monorepos where the database migrations could fail if the packages/db directory doesn't have its own .env file.

The modification adds a crucial step before running database migrations: setting up the database package's own environment configuration. This involves copying .env.example to .env in the packages/db directory and configuring it with the DATABASE_URL. This ensures that the Drizzle ORM migrations have direct access to the database connection string when executed from the database package context.

This change aligns with the monorepo architecture where different packages may require their own environment configurations. The updated instructions provide a more reliable setup process by explicitly configuring both the main application environment (apps/sim/.env) and the database package environment (packages/db/.env) separately, preventing potential setup failures for developers following the manual installation process.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only improves documentation
  • Score reflects simple documentation changes that enhance setup clarity without affecting code functionality
  • No files require special attention as this is a straightforward documentation update

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

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

Successfully merging this pull request may close these issues.

2 participants