DOCS UPDATE: Fix incorrect .env file location in Backend Setup instructions
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, supabase
- Domain
- backend, documentation
Research direction
Open README.md and review the Backend Setup and Start Development Servers sections described in the issue. Update the numbered steps, clarify that .env belongs in backend, and ensure the backend command is shown as running from backend with uvicorn app.main:app --reload. Done means the documented setup matches the working directory and file location.
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
The current README instructions for Backend Setup (Section 3) contain incorrect information about where to create the .env file and from which directory to run the backend server.
Specifically:
- Step 3 instructs users to navigate to the
backend/appdirectory (cd app) - Step 4 tells users to create a
.envfile (implying it should be inbackend/app) - Step 2 under "Start Development Servers" instructs running the backend from
backend/appdirectory
✨ Proposed Changes
- Remove the misleading navigation step - Delete step 3 that tells users to
cd app - Correct the .env file location - Update the instruction to clearly state: "Create a
.envfile in the backend directory using.env-exampleas a reference" - Update the backend server start command - Change from
uvicorn main:app --reload(run from backend/app) touvicorn app.main:app --reload(run from backend directory) - Renumber the steps accordingly after removing step 3
Updated Backend Setup section should read:
- Step 2: Install dependencies
- Step 3: Create
.envfile in the backend directory - Step 4: Obtain Supabase credentials
- Step 5: Get Groq API key
And the start command should specify running from the backend directory with uvicorn app.main:app --reload
📋 Additional Context
I encountered this issue while setting up the project for GSoC contribution. The setup failed when following the current instructions, and only worked after moving the .env file from backend/app/ to backend/.
This is a critical fix as it prevents new contributors from successfully running the project on their first attempt, which can be discouraging for newcomers.
Relevant Documentation Link (if any)
https://github.com/PulkitDadwal/InPactAI/blob/documentation_fix/README.md
Record
- I agree to follow this project's Code of Conduct
- I want to work on this update
- Dominant language
- TypeScript
- Stars
- 102
- Forks
- 144
- 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/InPactAI
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AOSSIE-Org/InPactAI#218 ·
-
Difficulty 5/5 Over a week Newbie friendliness 42/100
AOSSIE-Org/InPactAI#314 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
AOSSIE-Org/InPactAI#312 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
AOSSIE-Org/InPactAI#307 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
AOSSIE-Org/InPactAI#306 · 1 comment ·
All issues in AOSSIE-Org/InPactAI
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100