Skip to content

Fix backend startup documentation and uvicorn execution path #300

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
Aditya30ag wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix backend startup documentation and uvicorn execution path #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added Backend/app/__init__.py
View file
Open in desktop
Empty file.
Empty file added Backend/app/db/__init__.py
View file
Open in desktop
Empty file.
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,14 @@ cd app
npm run dev
```

2. Start the backend server (from the backend/app directory):
2. Start the backend server (from the Backend directory):
```sh
uvicorn main:app --reload
cd Backend
uvicorn app.main:app --reload
Comment on lines +176 to +179
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Critical: Path navigation will fail if instructions are followed sequentially.

The instruction at line 178 cd Backend won't work for users following the setup steps in order. By line 178, users are in the backend/app/ directory (from line 130: cd app), so cd Backend will fail with "directory not found."

Additionally, there's a case sensitivity inconsistency: line 119 uses lowercase backend while line 178 uses capitalized Backend. On case-sensitive filesystems (Linux/Mac), these are different directories.

🔧 Proposed fix for correct navigation and case consistency

Option 1 (Recommended): Fix the navigation command to go back to the Backend directory:

 2. Start the backend server (from the Backend directory):
 ```sh
-cd Backend
+cd ..
 uvicorn app.main:app --reload

**Option 2**: Remove the `cd` command and clarify the starting location in the instruction text:

```diff
-2. Start the backend server (from the Backend directory):
+2. Start the backend server (navigate back to the Backend directory first):
 ```sh
-cd Backend
 uvicorn app.main:app --reload


Also ensure case consistency throughout the document. Verify the actual directory name in the repository and use it consistently (either always `backend` or always `Backend`).

</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
2. Start the backend server (from the Backend directory):
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 176 - 179, The README navigation is wrong and
case-inconsistent: replace the incorrect "cd Backend" step (the exact "cd
Backend" command) with "cd .." so users return from backend/app to the Backend
directory before running "uvicorn app.main:app --reload", and audit/normalize
all occurrences of the directory name (instances of "backend" vs "Backend")
across the README to match the repository's actual directory casing.

```

**Important**: Do not run the server from inside the `app/` directory as this will cause relative import errors. The application must be executed from the project root so that `app` is treated as a proper Python package.
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify "project root" terminology to prevent confusion.

The phrase "project root" is ambiguous—it could refer to either the repository root (InPact/) or the Backend directory root (Backend/). Based on the uvicorn command uvicorn app.main:app, users should run from the Backend/ directory, not the repository root.

📝 Proposed fix for clearer terminology 
-**Important**: Do not run the server from inside the `app/` directory as this will cause relative import errors. The application must be executed from the project root so that `app` is treated as a proper Python package.
+**Important**: Do not run the server from inside the `app/` directory as this will cause relative import errors. The application must be executed from the `Backend/` directory (the backend root) so that `app` is treated as a proper Python package.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Important**: Do not run the server from inside the `app/` directory as this will cause relative import errors. The application must be executed from the project root so that `app` is treated as a proper Python package.
**Important**: Do not run the server from inside the `app/` directory as this will cause relative import errors. The application must be executed from the `Backend/` directory (the backend root) so that `app` is treated as a proper Python package.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 182, The README's "project root" is ambiguous—update the
sentence referencing running the server from the correct location: specify that
users must run the uvicorn command from the Backend directory (where the command
`uvicorn app.main:app` should be executed) rather than the repository root, and
clarify that running from inside the `app/` directory will cause relative import
errors because `app` must be a package; replace "project root" with "Backend/
directory (project backend root)" and include the exact `uvicorn app.main:app`
example to make the intended working directory explicit.


## Data Population

To populate the database with initial data, follow these steps:
Expand Down