Skip to content

Update README.md #65

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update README.md #65

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
49cd7be
Update README.md
Akshayp0105 Aug 15, 2025
6160b59
Update README.md
Akshayp0105 Aug 15, 2025
164e869
Update README.md
Akshayp0105 Aug 15, 2025
dc65df7
Update README.md
Akshayp0105 Aug 15, 2025
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
131 changes: 63 additions & 68 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,102 +1,97 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />
MapGo 🎯
Basic Details
Team Name: DevGeeks
Team Members

Team Lead: Akshay P – TIST Kochi

# [Project Name] 🎯
Member 2: Adithyan Biju – TIST Kochi

Project Description

## Basic Details
### Team Name: [Name]
MapGo is a parody navigation web app that refuses to give you the shortest route. Instead, it finds the longest possible way to your destination — perfect for long talks, road trip vibes, or pranking friends. You can even choose fun distance multipliers like 2x, 3x, or Crush Mode ❤️ to maximize detours while still reaching your destination… eventually.

The Problem (that doesn't exist)

### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
Reaching your destination too quickly ruins the fun. How can you enjoy quality time or suspense if Google Maps keeps taking the shortest route?

### Project Description
[2-3 lines about what your project does]
The Solution (that nobody asked for)

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
We built MapGo, a map app that deliberately makes your trip longer. It calculates maximum-distance routes and lets you customize just how long you want to be on the road — because sometimes, wasting time is the point.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
Technical Details
Technologies/Components Used

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]

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:
- [List main components]
- [List specifications]
- [List tools required]

### Implementation
For Software:
# Installation
[commands]
None — 100% software.

# Run
[commands]
Implementation

### Project Documentation
For Software:
Installation

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
# Clone the repo
git clone https://github.com/Akshayp0105/mapgo
Copy link

Choose a reason for hiding this comment

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

💡 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.md

Length 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.

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.


![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
# Frontend setup
cd frontend
npm install

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
# Backend setup
cd ../backend
pip install -r requirements.txt

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*

For Hardware:
Run

# Start frontend
npm run dev

# Start backend
python app.py
Comment on lines +58 to +61
Copy link

Choose a reason for hiding this comment

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

💡 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.py is 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' || true

Length 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
fi

Length 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.


Project Documentation
Screenshots

![Screenshot1](Add screenshot link)
Homepage showing map interface

![Screenshot2](Add screenshot link)
Route selection with "Crush Mode"

![Screenshot3](Add screenshot link)
Longest possible navigation path rendered on map

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
Diagrams

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*
![Workflow](Add workflow diagram link)
Flow of user input → backend route calculation → frontend display

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
Project Demo
Video

![Build](Add photos of build process here)
*Explain the build steps*
[Add demo video link here]
Demonstrates finding the longest route and using multipliers.

![Final](Add photo of final product here)
*Explain the final build*
Team Contributions

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
Akshay P: Frontend development, UI/UX design, integration with Leaflet.js, Firebase setup

# Additional Demos
[Add any extra demo materials/links]
Adithyan Biju: Backend development with FastAPI, route calculation logic, API integration

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
Made with ❤️ at TinkerHub Useless Projects

---
Made with ❤️ at TinkerHub Useless Projects

![Static Badge](https://img.shields.io/badge/TinkerHub-24?color=%23000000&link=https%3A%2F%2Fwww.tinkerhub.org%2F)
![Static Badge](https://img.shields.io/badge/UselessProjects--25-25?link=https%3A%2F%2Fwww.tinkerhub.org%2Fevents%2FQ2Q1TQKX6Q%2FUseless%2520Projects)