DOCS UPDATE: Incorrect Flask command path in backend installation guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Open docs/INSTALL_GUIDE.md and review the Quick Start section, specifically Step 8 for starting the backend server. Verify the working directory and Flask command against the path described in the issue; done means the guide no longer gives the incorrect path and can start the code-graph backend as documented.
Written by the indexing model from the issue text.
Description
Is this related to an existing part of the documentation?
- Yes, it is related to an existing section
What needs to be updated?
📌 Current Documentation Issue
In the Installation Guide → Quick Start → Step 8 (Start the backend server), the documentation instructs users to run the following command from the backend directory:
flask --app api/index.py run --debug --port 5000
However, this command fails when executed from the backend/ directory because the Flask application file (index.py) is not located at backend/api/index.py. The actual Flask app is located at:
backend/app/database/falkor/code-graph-backend/api/index.py
As a result, running the command exactly as written leads to the error:
Error: Could not import 'index'
This can be confusing for new contributors, especially on Windows.
✨ Proposed Changes
Update Step 8 of the installation guide to reflect the correct working directory and Flask app path.
Suggested corrected instructions:
# Terminal 3 (Start graphDB / Code Graph Backend)
cd app/database/falkor/code-graph-backend
flask --app api.index run --debug --port 5000
Optionally, the guide could also mention that:
The Flask command must be run from the code-graph-backend directory
This change would make the setup instructions accurate and reduce onboarding friction.
📋 Additional Context
This issue was encountered during a fresh local setup following the installation guide step-by-step.
The rest of the backend (FastAPI, Docker services, Discord bot) works as expected once this path issue is resolved.
Relevant Documentation Link (if any)
https://github.com/AOSSIE-Org/Devr.AI/blob/main/docs/INSTALL_GUIDE.md#quick-start
Record
- I agree to follow this project's Code of Conduct
- I want to work on this update
- Dominant language
- Python
- Stars
- 102
- Forks
- 138
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AOSSIE-Org/Devr.AI
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
AOSSIE-Org/Devr.AI#305 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
AOSSIE-Org/Devr.AI#304 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
AOSSIE-Org/Devr.AI#303 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
AOSSIE-Org/Devr.AI#300 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
AOSSIE-Org/Devr.AI#295 ·
All issues in AOSSIE-Org/Devr.AI
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100