Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md to Include TurboRepo Setup Instructions #14

Open
TanviAgarwal-14 opened this issue Aug 15, 2024 · 1 comment
Open

Update README.md to Include TurboRepo Setup Instructions #14

TanviAgarwal-14 opened this issue Aug 15, 2024 · 1 comment

Comments

@TanviAgarwal-14
Copy link

The current README.md does not include instructions for setting up and running the project with TurboRepo, which is essential for development. Users may encounter issues if TurboRepo is not installed or if commands are not recognized.

Description:

The current README.md does not include instructions for setting up and running the project with TurboRepo, which is essential for development. Users may encounter issues if TurboRepo is not installed or if commands are not recognized.

Proposed Changes:

Install TurboRepo:

Add instructions for installing TurboRepo globally or using npx to run Turbo commands.
Setup and Running Instructions:

Clarify the steps for creating a .env file, installing dependencies, and starting the development server.
Troubleshooting Tips:

Provide guidance on how to resolve common issues related to TurboRepo commands.
Additional Information:

Ensure the README.md mentions the need for Node.js version >=18 and includes a link to TurboRepo documentation.

@TanviAgarwal-14
Copy link
Author

I would Love to work on this issue @c2siorg @kmehant @charithccmc @Niweera

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

No branches or pull requests

1 participant