Update README.md #65
Update README.md #65
Conversation
WalkthroughRewrote the repository README into a software-focused MapGo/LongCut Maps README: new project header and team, full problem/solution narrative (longest-route with multipliers), explicit tech stack, consolidated frontend/backend setup and run instructions, and removal of hardware, badges, and placeholder media. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (7)
README.md (7)
36-38: Fix Markdown lint issues: remove trailing colon in heading and avoid emphasis as a heading.MD026 flags the trailing colon in a heading. MD036 flags using bold text as a heading. Use proper headings.
-#### For Software: +#### Software -**Installation** +##### Installation
7-8: Capitalize the institution name and remove extra spaces.Correct casing and spacing for professionalism and consistency.
-- Team Lead: Akshay P - Toc H institute of science and technology - - Member 2: Adithyan Biju - Toc H institute of science and technology +- Team Lead: Akshay P - Toc H Institute of Science and Technology +- Member 2: Adithyan Biju - Toc H Institute of Science and Technology
24-27: Clarify whether both Firebase Auth and Supabase are used, and for what.Using both can be confusing. If both are used, specify their roles (e.g., Firebase for auth, Supabase for database). If only one is used, remove the other to avoid ambiguity.
If both are used, consider adding a short usage note like:
- Firebase Auth: user authentication
- Supabase: Postgres + Row Level Security for app data
24-27: Optional: add version/tooling requirements to reduce setup friction.Consider noting minimum versions and recommended tooling:
- Node.js (e.g., >= 18)
- npm or pnpm version
- Python (e.g., 3.10+)
- Virtual environment usage (.venv), and a pointer to a .env.example
11-18: Fun description reads well; just ensure tone aligns with target audience/context.If this README is for a hackathon or student project, the playful tone is perfect. If it’s meant for broader open-source contributors or recruiters, consider adding a short “serious” note about the algorithmic/technical goals beneath the parody copy.
22-27: Optional: link to the specific libraries/services.Convert items to links (React, FastAPI, Leaflet, Firebase Auth, Supabase, Axios, Vercel, Render) to improve discoverability.
34-36: Consider adding “Usage” and “Environment variables” subsections under Implementation.
- Usage: a short walkthrough (enter origin/destination, select 2x/3x/Crush Mode)
- Environment: list required keys (Firebase, Supabase URL/anon key, backend API URL) with a .env.example
I can draft a .env.example and a short Usage section if you share which provider (Firebase/Supabase) you actually use and the expected env var names.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: There might be a mistake here.
Context: # LongCut Maps 🎯 ## Basic Details ### Team Name: LongCut Lege...
(QB_NEW_EN)
[grammar] ~3-~3: There might be a mistake here.
Context: # LongCut Maps 🎯 ## Basic Details ### Team Name: LongCut Legends ### Team Mem...
(QB_NEW_EN)
[grammar] ~6-~6: There might be a mistake here.
Context: ... Name: LongCut Legends ### Team Members - Team Lead: Akshay P - Toc H institute of...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...### The Solution (that nobody asked for) We built LongCut Maps — a navigation app...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...… eventually. --- ## Technical Details ### Technologies/Components Used For Softwar...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...Details ### Technologies/Components Used For Software: - Languages: JavaScrip...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...chnologies/Components Used For Software: - Languages: JavaScript, Python - **Fr...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...are: - Languages: JavaScript, Python - Frameworks: React.js (Frontend), FastA...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...* React.js (Frontend), FastAPI (Backend) - Libraries: Leaflet.js (maps), Firebase...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...s (maps), Firebase Auth, Supabase, Axios - Tools: Vercel (Frontend deploy), Pytho...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
36-36: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
38-38: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
README.md (2)
30-31: LGTM: clear statement that no hardware is involved.This avoids confusion given the team template origins.
39-54: Close README code fence and add minimal run instructions — confirm backend entrypointThe fenced code block in README.md (Lines 39–54) is not closed and the instructions stop at dependency installation; please close the fence and add short run commands. I ran the suggested checks but could not locate frontend/backend directories, package.json, requirements.txt, or a FastAPI app signature in the repo — please confirm paths and the FastAPI entrypoint (so the uvicorn command uses the correct module).
Files to update
- README.md (Lines 39–54): close the open ```bash block and append concise run commands.
- Verify repository layout: frontend/package.json and backend/requirements.txt exist (or adjust paths accordingly).
- Verify backend FastAPI entrypoint (e.g., main:app or app.main:app) and update the uvicorn command.
Suggested diff to apply
@@ README.md ```bash # Clone repo git clone https://github.com/Akshayp0105/mapgo # Install frontend dependencies cd frontend npm install # Install backend dependencies cd ../backend pip install -r requirements.txt + +# Run frontend (in a separate terminal) +cd ../frontend +npm run dev # or: npm start + +# Run backend (from project root or backend/) +cd ../backend +# If uvicorn is not installed: pip install uvicorn +uvicorn main:app --reload # adjust module path if needed, e.g., app.main:app +```
| **Installation** | ||
| ```bash | ||
| # Clone repo | ||
| git clone https://github.com/Akshayp0105/mapgo |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the clone URL points to the canonical repo for LongCut Maps.
Project is branded “LongCut Maps” yet the URL is “Akshayp0105/mapgo”. If this README lives in a different repo, update the URL to match this repo to avoid confusion for contributors.
Run to compare the current repo origin versus README link:
🏁 Script executed:
#!/bin/bash
set -e
echo "Repo origin:"
git remote -v || true
echo
echo "README clone URL:"
rg -nP '^git clone\s+(?P<url>\S+)' README.mdLength of output: 358
Fix README clone URL — mismatch with repo origin
The README lists "git clone https://github.com/Akshayp0105/mapgo" but this repo's origin is "https://github.com/tinkerhub/useless_project_temp.git". Update the README or the repository remote so the clone URL and canonical repo match.
- Location to fix:
- README.md — line 41:
git clone https://github.com/Akshayp0105/mapgo
- README.md — line 41:
- Suggested replacement (if the current origin is canonical):
If Akshayp0105/mapgo is the intended canonical repo, update the repository remote instead and ensure README and remote both point to that canonical URL.
🤖 Prompt for AI Agents
In README.md around line 41, the clone URL is incorrect (currently "git clone
https://github.com/Akshayp0105/mapgo") and must match the repository origin;
update the README to replace that line with the canonical URL "git clone
https://github.com/tinkerhub/useless_project_temp.git" (or, if the
Akshayp0105/mapgo repo is the intended canonical source, update the repository
remote to point to that URL and then ensure README and git remote match); make
the change so the clone command in README and the repo remote are consistent.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
41-41: Clone URL likely mismatches repo origin—make them consistent.This repeats the prior review finding; ensure the README’s clone URL matches the canonical repository.
If this repo (origin) is canonical, update README:
-git clone https://github.com/Akshayp0105/mapgo +git clone https://github.com/tinkerhub/useless_project_temp.gitIf https://github.com/Akshayp0105/mapgo is canonical, update the repo remote instead and keep README aligned.
Run to verify current origin vs README link:
#!/bin/bash set -e echo "Repo origin:" git remote -v || true echo echo "README clone URL:" rg -nP '^git clone\s+(?P<url>\S+)' README.md
🧹 Nitpick comments (5)
README.md (5)
7-8: Fix names/institution spelling and formatting in Team Members.Correct casing, spacing, and spelling for readability and professionalism.
-- Team Lead: AKSHAY P- TOC H INSTITUTE OF SCIENCE AND TECNOLOGY - - Member 2: Adithyan Biju - TOC H INSTITUTE OF SCIENCE AND TECNOLOGY +- Team Lead: Akshay P — Toc H Institute of Science and Technology +- Member 2: Adithyan Biju — Toc H Institute of Science and Technology
36-36: Remove trailing colon in heading to satisfy markdownlint (MD026).-#### For Software: +#### For Software
38-38: Use a proper heading instead of bold text (markdownlint MD036).Promotes consistent structure and navigability.
-**Installation** +##### Installation
24-27: Confirm actual usage of both Firebase Auth and Supabase or narrow the list.Listing both auth/backends can confuse contributors if only one is used. Trim to what’s in use, or add a short rationale explaining both.
43-49: Action required — README run instructions need confirmation (frontend/backend missing)Verification shows both ./frontend and ./backend directories are missing, so I couldn't validate adding run/venv steps. Please confirm the actual service folder names or add the folders; then apply the changes below.
- File: README.md (lines 43–49) — extend the install section with run/venv commands once paths are confirmed.
Suggested diff (apply only if those folders exist):
# Install frontend dependencies cd frontend npm install +# +# Run frontend (from ./frontend) +npm run dev @@ # Install backend dependencies cd ../backend pip install -r requirements.txt +# +# (Optional) Create/activate virtualenv before installing: +# python -m venv .venv && source .venv/bin/activate +# +# Run backend (from ./backend) +# Adjust module path if different: +uvicorn main:app --reload
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: There might be a mistake here.
Context: # LongCut Maps 🎯 ## Basic Details ### Team Name: LongCut Lege...
(QB_NEW_EN)
[grammar] ~3-~3: There might be a mistake here.
Context: # LongCut Maps 🎯 ## Basic Details ### Team Name: LongCut Legends ### Team Mem...
(QB_NEW_EN)
[grammar] ~6-~6: There might be a mistake here.
Context: ... Name: LongCut Legends ### Team Members - Team Lead: AKSHAY P- TOC H INSTITUTE OF ...
(QB_NEW_EN)
[grammar] ~7-~7: Ensure spelling is correct
Context: ...KSHAY P- TOC H INSTITUTE OF SCIENCE AND TECNOLOGY - Member 2: Adithyan Biju - TOC H INSTITU...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~8-~8: Ensure spelling is correct
Context: ... Biju - TOC H INSTITUTE OF SCIENCE AND TECNOLOGY ### Project Description LongCut Maps is a pa...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~16-~16: There might be a mistake here.
Context: ...### The Solution (that nobody asked for) We built LongCut Maps — a navigation app...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...… eventually. --- ## Technical Details ### Technologies/Components Used For Softwar...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...Details ### Technologies/Components Used For Software: - Languages: JavaScrip...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...chnologies/Components Used For Software: - Languages: JavaScript, Python - **Fr...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...are: - Languages: JavaScript, Python - Frameworks: React.js (Frontend), FastA...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...* React.js (Frontend), FastAPI (Backend) - Libraries: Leaflet.js (maps), Firebase...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...s (maps), Firebase Auth, Supabase, Axios - Tools: Vercel (Frontend deploy), Pytho...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
36-36: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
38-38: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
45-45: Fix README clone URL — mismatch with repo origin (repeat)Same issue noted previously: ensure the clone URL matches the canonical repository remote to avoid contributor confusion.
If this repo’s origin is canonical, update README to that URL; otherwise update the remote and README together. Example diff if the canonical is the current repo:
-git clone https://github.com/Akshayp0105/mapgo +git clone https://github.com/tinkerhub/useless_project_temp.gitRun this to verify the current remote versus README:
#!/bin/bash set -e echo "Repo origin:" git remote -v || true echo echo "README clone URL:" rg -nP '^git clone\s+\S+' README.md -n
🧹 Nitpick comments (4)
README.md (4)
1-4: Convert plain text headings to proper Markdown and structure contentCurrent headings are plain lines, so they won’t render as headers on GitHub. Also, lists are easier to scan than inline labels. This refactor improves readability, fixes several grammar flags, and addresses markdownlint hints by adding fenced code blocks for commands.
Apply the following structured Markdown:
-LongCut Maps 🎯 -Basic Details -Team Name: DevGeeks -Team Members +# LongCut Maps 🎯 + +## Basic Details + +- Team Name: DevGeeks + +### Team Members -Project Description +## Project Description LongCut Maps is a parody of Google Maps that never gives you the shortest path. Instead, it calculates the longest possible route to your destination — perfect for spending more time with your crush, enjoying a road trip, or simply trolling your friends. -The Problem (that doesn't exist) +## The Problem (that doesn't exist) People keep reaching their destination too quickly. How are you supposed to build suspense or have long romantic talks when Google Maps keeps cutting your trip short? -The Solution (that nobody asked for) +## The Solution (that nobody asked for) We built LongCut Maps — a navigation app that deliberately picks the longest possible path to your destination. You can even select multipliers like 2x, 3x, or Crush Mode ❤️ for maximum detour enjoyment. It still gets you to your destination… eventually. -Technical Details -Technologies/Components Used +## Technical Details +### Technologies and Components -For Software: +#### Software -Languages: JavaScript, Python +- Languages: JavaScript, Python -Frameworks: React.js (Frontend), FastAPI (Backend) +- Frameworks: React.js (Frontend), FastAPI (Backend) -Libraries: Leaflet.js (maps), Firebase Auth, Supabase, Axios +- Libraries: Leaflet.js (maps), Firebase Auth, Supabase, Axios -Tools: Vercel (Frontend deploy), PythonAnywhere/Render (Backend deploy), GitHub +- Tools: Vercel (Frontend deploy), PythonAnywhere/Render (Backend deploy), GitHub -For Hardware: +#### Hardware -None — this is a 100% software-based prank navigation tool. +- None — this is a 100% software-based prank navigation tool. -Implementation -For Software: +## Implementation -Installation +### Installation -# Clone repo -git clone https://github.com/Akshayp0105/mapgo +Clone the repository: +```bash +git clone https://github.com/Akshayp0105/mapgo +``` -# Install frontend dependencies -cd frontend -npm install +Install frontend dependencies: +```bash +cd frontend +npm install +``` -# Install backend dependencies -cd ../backend -pip install -r requirements.txt +Install backend dependencies: +```bash +cd ../backend +pip install -r requirements.txt +```Also applies to: 10-22, 22-37, 39-55
6-6: Replace placeholder college names with actual values or remove placeholdersThe bracketed “[Your College Name Here]” suggests unfinished content and reads unpolished.
-Team Lead: Akshay P – [Your College Name Here] +Team Lead: Akshay P – <College Name> -Member 2: Adithyan Biju – [Your College Name Here] +Member 2: Adithyan Biju – <College Name>If the college names are not required, drop them entirely to avoid placeholders.
Also applies to: 8-8
44-53: Wrap install commands in fenced code blocks to satisfy markdownlint (MD034) and improve readabilityBare URLs inside shell lines trigger MD034; fencing the commands avoids autolinking and renders commands correctly.
The larger heading refactor above already adds fences; if you prefer a minimal change, at least wrap the three install segments with triple-backtick code blocks as shown there.
47-53: Add “Run” and “Configuration” steps (env vars, dev server commands)The README covers installation but not how to run frontend/backend or required environment variables (e.g., Firebase, Supabase, map tiles). This blocks first-time contributors.
Proposed sections to add after Installation:
- Usage/Running locally: commands to start the frontend (e.g., npm scripts) and backend (e.g., FastAPI server command).
- Configuration: list required environment variables and how to set them locally.
Share the actual script names (package.json) and backend entrypoint, and I can draft the exact README snippets.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: There might be a mistake here.
Context: LongCut Maps 🎯 Basic Details Team Name: DevGeeks Team Me...
(QB_NEW_EN)
[grammar] ~2-~2: There might be a mistake here.
Context: LongCut Maps 🎯 Basic Details Team Name: DevGeeks Team Members Team Le...
(QB_NEW_EN)
[grammar] ~3-~3: There might be a mistake here.
Context: ...ps 🎯 Basic Details Team Name: DevGeeks Team Members Team Lead: Akshay P – [Your...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: ...Details Team Name: DevGeeks Team Members Team Lead: Akshay P – [Your College Name ...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...olling your friends. The Problem (that doesn't exist) People keep reaching their dest...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...tination… eventually. Technical Details Technologies/Components Used For Softwa...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...d prank navigation tool. Implementation For Software: Installation # Clone rep...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...nstall frontend dependencies cd frontend npm install # Install backend dependenc...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...stall backend dependencies cd ../backend pip install -r requirements.txt
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
45-45: Bare URL used
(MD034, no-bare-urls)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
44-44: Fix README clone URL — must match repo origin (duplicate of earlier review)The clone URL still points to “https://github.com/Akshayp0105/mapgo”. Ensure it matches the canonical repository remote. Update either the README or the remote so they are consistent.
Run to compare the current repo origin versus README link:
#!/bin/bash set -e echo "Repo origin:" git remote -v || true echo echo "README clone URL:" rg -nP '^git clone\s+(?P<url>\S+)' README.mdIf this repo’s origin is different, replace the README clone line accordingly.
🧹 Nitpick comments (6)
README.md (6)
1-10: Use proper Markdown headings and compact the team section for readabilityConvert the plain lines into headings and bullet points. This also improves navigation and automatic TOC generation in platforms like GitHub.
-MapGo 🎯 -Basic Details -Team Name: DevGeeks -Team Members - -Team Lead: Akshay P – TIST Kochi - -Member 2: Adithyan Biju – TIST Kochi +# MapGo 🎯 + +## Basic Details +- Team Name: DevGeeks +- Team Lead: Akshay P – TIST Kochi +- Team Members: + - Adithyan Biju – TIST Kochi
22-38: Normalize “Technical Details” with headings and lists; collapse hardware noteCurrent formatting is a mix of labels and blank lines. Use headings and bullet lists for consistency. Keep the “100% software” note under a Hardware heading.
-Technical Details -Technologies/Components Used - -For Software: - -Languages: JavaScript, Python - -Frameworks: React.js (Frontend), FastAPI (Backend) - -Libraries: Leaflet.js, Firebase Auth, Supabase, Axios - -Tools: Vercel (Frontend deployment), Render/PythonAnywhere (Backend deployment), GitHub - -For Hardware: - -None — 100% software. +## Technical Details +### Technologies/Components Used (Software) +- Languages: JavaScript, Python +- Frameworks: React (frontend), FastAPI (backend) +- Libraries: Leaflet.js, Firebase Auth, Supabase, Axios +- Tools: Vercel (frontend deploy), Render/PythonAnywhere (backend deploy), GitHub + +### Hardware +- None — 100% software
41-61: Wrap commands in fenced code blocks and clarify directory contextThis resolves MD034 (bare URLs) and prevents confusion about where to run each command.
-Installation - -# Clone the repo -git clone https://github.com/Akshayp0105/mapgo - -# Frontend setup -cd frontend -npm install - -# Backend setup -cd ../backend -pip install -r requirements.txt +Installation + +```bash +# Clone the repo +git clone https://github.com/Akshayp0105/mapgo +cd mapgo + +# Frontend setup +cd frontend && npm install + +# Backend setup +cd ../backend && pip install -r requirements.txt +``` @@ -Run - -# Start frontend -npm run dev - -# Start backend -python app.py +Run + +```bash +# Terminal 1 — Start frontend +cd frontend && npm run dev + +# Terminal 2 — Start backend +cd backend && python app.py +```
63-85: Replace placeholder media with TODOs or remove until availablePlaceholders like “Add screenshot link” and empty demo link degrade README quality. Either provide real links or mark as TODO to avoid broken/bare content.
-Project Documentation -Screenshots - - -Homepage showing map interface - - -Route selection with "Crush Mode" - - -Longest possible navigation path rendered on map +Project Documentation +### Screenshots +- [ ] Homepage showing map interface — add image link +- [ ] Route selection with “Crush Mode” — add image link +- [ ] Longest-route map render — add image link @@ -Diagrams - - -Flow of user input → backend route calculation → frontend display +### Diagrams +- [ ] Workflow (user input → backend route calc → frontend display) — add diagram link @@ -Project Demo -Video - -[Add demo video link here] -Demonstrates finding the longest route and using multipliers. +### Project Demo +- [ ] Add demo video link (show longest-route and multiplier modes)I can help convert these to asset links if you share the files or URLs.
86-91: Format team contributions as a concise bullet listImproves scanability and consistency with earlier sections.
-Team Contributions - -Akshay P: Frontend development, UI/UX design, integration with Leaflet.js, Firebase setup - -Adithyan Biju: Backend development with FastAPI, route calculation logic, API integration +## Team Contributions +- Akshay P — Frontend development, UI/UX, Leaflet.js integration, Firebase setup +- Adithyan Biju — Backend (FastAPI), route logic, API integration
39-41: Add a “Configuration” section for environment variablesGiven Firebase Auth and Supabase are listed, add a minimal env section so new contributors can run locally without guesswork.
-Implementation +Implementation + +### Configuration +Create `.env` files for frontend and backend with the required keys. +- Frontend (example): + - VITE_SUPABASE_URL= + - VITE_SUPABASE_ANON_KEY= + - VITE_FIREBASE_API_KEY= + - VITE_FIREBASE_AUTH_DOMAIN= +- Backend (example): + - SUPABASE_URL= + - SUPABASE_SERVICE_ROLE_KEY= + - GOOGLE_MAPS_API_KEY= # if applicableI can tailor the exact env keys if you share the current config usage in code.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: There might be a mistake here.
Context: MapGo 🎯 Basic Details Team Name: DevGeeks Team Me...
(QB_NEW_EN)
[grammar] ~2-~2: There might be a mistake here.
Context: MapGo 🎯 Basic Details Team Name: DevGeeks Team Members Team Le...
(QB_NEW_EN)
[grammar] ~3-~3: There might be a mistake here.
Context: ...Go 🎯 Basic Details Team Name: DevGeeks Team Members Team Lead: Akshay P – TIST ...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: ...Details Team Name: DevGeeks Team Members Team Lead: Akshay P – TIST Kochi Member ...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...ination… eventually. The Problem (that doesn't exist) Reaching your destination too q...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...ng time is the point. Technical Details Technologies/Components Used For Softwa...
(QB_NEW_EN)
[grammar] ~47-~47: There might be a mistake here.
Context: ...0105/mapgo # Frontend setup cd frontend npm install # Backend setup cd ../backe...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...m install # Backend setup cd ../backend pip install -r requirements.txt Run #...
(QB_NEW_EN)
[grammar] ~63-~63: There might be a mistake here.
Context: ...end python app.py Project Documentation Screenshots 
[grammar] ~66-~66: There might be a mistake here.
Context: ...ots  Homepage showing map interface ![Screen...
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...ace  Route selection with "Crush Mode" ![Scr...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...de"  Longest possible navigation path rendere...
(QB_NEW_EN)
[style] ~76-~76: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2263 characters long)
Context: ...igation path rendered on map Diagrams  Fl...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~77-~77: There might be a mistake here.
Context: ...  Flow of user input → backend route calcu...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...ulation → frontend display Project Demo Video [Add demo video link here] Demons...
(QB_NEW_EN)
[grammar] ~83-~83: There might be a mistake here.
Context: ...t Demo Video [Add demo video link here] Demonstrates finding the longest route a...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
44-44: Bare URL used
(MD034, no-bare-urls)
| npm run dev | ||
|
|
||
| # Start backend | ||
| python app.py |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify FastAPI start command; consider uvicorn instead of python app.py
If the backend is FastAPI, the canonical way is usually via uvicorn (e.g., uvicorn <module>:app --reload). Please confirm that python app.py correctly starts the ASGI server, or update the README to the correct uvicorn command.
Expected:
- If uvicorn is present, prefer documenting:
uvicorn <module>:app --reload --port 8000. - If a
__main__in app.py starts uvicorn,python app.pyis okay; otherwise update README.
🏁 Script executed:
#!/bin/bash
# Try to infer the correct FastAPI entrypoint and whether uvicorn is used.
echo "FastAPI usage:"
rg -n -C2 'from\s+fastapi\s+import\s+FastAPI|FastAPI\('
echo
echo "uvicorn usage:"
rg -n -C2 'uvicorn|__main__.*uvicorn\.run|uvicorn\.run'
echo
echo "Likely app factory or instance names:"
rg -n -C1 'app\s*=\s*FastAPI\('Length of output: 328
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== README.md snippet (lines 1-120) ==="
if [ -f README.md ]; then
nl -ba README.md | sed -n '1,120p'
else
echo "README.md not found"
fi
echo
echo "=== README.md lines 56-70 ==="
if [ -f README.md ]; then
nl -ba README.md | sed -n '56,70p'
fi
echo
echo "=== Locate app.py ==="
APP_PATH=$(find . -type f -name "app.py" -print -quit || true)
if [ -n "$APP_PATH" ]; then
echo "Found app.py at: $APP_PATH"
echo
echo "=== app.py (first 200 lines) ==="
sed -n '1,200p' "$APP_PATH"
else
echo "No app.py found in repo"
fi
echo
echo "=== List top-level Python files (first 200 matches) ==="
find . -type f -name "*.py" -print | sed -n '1,200p' || true
echo
echo "=== Search for FastAPI usage (case-insensitive) ==="
rg -n -i --hidden --no-ignore -S 'from\s+fastapi\s+import\s+FastAPI|FastAPI\(' || true
echo
echo "=== Search for Flask usage ==="
rg -n -i --hidden --no-ignore -S 'from\s+flask|Flask\(' || true
echo
echo "=== Search for uvicorn usage ==="
rg -n --hidden --no-ignore -S 'uvicorn|uvicorn\.run' || true
echo
echo "=== Search for __main__ blocks ==="
rg -n --hidden --no-ignore -S '__main__' || true
echo
echo "=== Search for 'python app.py' occurrences in repo ==="
rg -n --hidden --no-ignore -S 'python\s+app\.py' || trueLength of output: 259
🏁 Script executed:
#!/bin/bash
# Safer inspection script (avoids `nl` which may be missing)
# Do not abort on errors so we can collect as much info as possible.
set -uo pipefail
echo "=== README.md (first 200 lines with numbers) ==="
if [ -f README.md ]; then
if command -v cat >/dev/null 2>&1; then
cat -n README.md | sed -n '1,200p'
else
sed -n '1,200p' README.md
fi
else
echo "README.md not found"
fi
echo
echo "=== README.md lines 56-70 ==="
if [ -f README.md ]; then
sed -n '56,70p' README.md || true
fi
echo
echo "=== Locate app.py (exact filename) ==="
APP_PATH=$(find . -type f -name "app.py" -print -quit 2>/dev/null || true)
if [ -n "$APP_PATH" ]; then
echo "Found app.py at: $APP_PATH"
echo "=== app.py (first 200 lines) ==="
sed -n '1,200p' "$APP_PATH" || true
else
echo "No app.py found"
fi
echo
echo "=== Top-level Python files (first 200) ==="
find . -type f -name "*.py" | sed -n '1,200p' || true
echo
echo "=== Search for FastAPI usage ==="
if command -v rg >/dev/null 2>&1; then
rg -n -S -i 'from\s+fastapi\s+import\s+FastAPI|FastAPI\(' || true
else
grep -R -n -E -i 'from\s+fastapi\s+import\s+FastAPI|FastAPI\(' . || true
fi
echo
echo "=== Search for Flask usage ==="
if command -v rg >/dev/null 2>&1; then
rg -n -S -i 'from\s+flask|Flask\(' || true
else
grep -R -n -E -i 'from\s+flask|Flask\(' . || true
fi
echo
echo "=== Search for uvicorn usage ==="
if command -v rg >/dev/null 2>&1; then
rg -n -S 'uvicorn|uvicorn\.run' || true
else
grep -R -n -E 'uvicorn|uvicorn\.run' . || true
fi
echo
echo "=== Search for __main__ blocks and app.run ==="
if command -v rg >/dev/null 2>&1; then
rg -n -S '__main__|if\s+__name__\s*==\s*["'\'']__main__["'\'']|app\.run\(' || true
else
grep -R -n -E '__main__|if\s+__name__\s*==\s*["'\'']__main__["'\'']|app\.run\(' . || true
fi
echo
echo "=== Search for occurrences of 'python app.py' in repo ==="
if command -v rg >/dev/null 2>&1; then
rg -n -S 'python\s+app\.py' || true
else
grep -R -n -E 'python\s+app\.py' . || true
fiLength of output: 4738
README: backend start command is incorrect — no app.py found; prefer uvicorn for FastAPI
Quick check: README shows "python app.py" (README.md:61) but there is no app.py in the repository and no FastAPI/uvicorn usage detected. Update the README or add the correct backend entrypoint.
-
Files to fix:
- README.md — "Run" section (lines ~56–61)
- Evidence: only occurrence is README.md:61; no app.py file found in repo.
-
Suggested replacement (update the Run section to a generic ASGI command — replace :app with your module path):
# Start frontend
npm run dev
# Start backend (FastAPI)
# Replace <module>:app with the module that exposes your FastAPI `app`, e.g. backend.main:app
uvicorn <module>:app --reload --port 8000
If you intentionally expect python app.py to work, ensure an app.py exists and that it starts uvicorn (e.g., via if __name__ == "__main__": uvicorn.run(...)). Otherwise, update README to the correct uvicorn command or the accurate module path.
🤖 Prompt for AI Agents
In README.md around lines 58 to 61, the "Run" section currently instructs to use
"python app.py" which fails because there is no app.py and the project uses an
ASGI FastAPI entrypoint; update the Run section to replace the incorrect python
app.py line with a uvicorn command (documenting to replace <module>:app with the
actual module that exposes the FastAPI app, e.g. backend.main:app) and keep the
frontend npm run dev line as-is; alternatively, if you intend to keep python
app.py, add an app.py that starts uvicorn under if __name__ == "__main__":
uvicorn.run(...) and ensure the README reflects that exact file.
Summary by CodeRabbit