diff --git a/README.md b/README.md index 597b39b44..7c7a1c2f6 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,97 @@ -frame (3) +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 -![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 + +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)