docs: Update and correct project setup instructions#41
Merged
CipherYuvraj merged 1 commit intoCipherYuvraj:mainfrom Oct 5, 2025
Merged
docs: Update and correct project setup instructions#41CipherYuvraj merged 1 commit intoCipherYuvraj:mainfrom
CipherYuvraj merged 1 commit intoCipherYuvraj:mainfrom
Conversation
github-actions
bot
added
good first issue
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello! This Pull Request updates the README.md file to fix several installation issues and clarify the setup process for new contributors.
The Problem
While setting up the project locally, I ran into a few problems because the current README.md has some outdated information:
Python Version Incompatibility: The README suggests Python 3.11+, but I discovered that the project's dependencies fail to install with Python 3.12 and 3.13. The correct, compatible version is Python 3.11.
Incorrect Build Tool: The "Tech Stack" section lists "Vite" as the frontend build tool, but the project is actually set up with "Create React App" (react-scripts).
Broken "Quick Start" Commands: The main npm run dev script in the "Quick Start" guide is broken and fails to start the servers correctly.
The Solution
This PR corrects the documentation to ensure a smooth setup experience:
Python Prerequisite: Updated the requirement to Python 3.11.x and added a note about the incompatibility with newer versions.
Tech Stack Table: Corrected the frontend build tool from "Vite" to "Create React App".
Quick Start Guide: Completely rewrote the "Quick Start" section with a new set of commands that are confirmed to work. The new guide explains the two-terminal process and includes the necessary virtual environment setup steps.