Home
SideQuest Wiki
Complete developer and user documentation for the hyper-local task marketplace
v 1.0.0
Firebase
MapLibre GL
SideQuest is a hyper-local, real-time task marketplace that connects neighbours. Post small tasks with a ₹ reward; earn money by completing your neighbours' quests — all tracked on a live map.
"You have money but no time. Your neighbour has time but needs money. SideQuest: now kith." 🤝
| Pillar | Description |
|---|---|
| 🗺️ Live Map | OpenStreetMap tiles rendered via MapLibre GL JS; colour-coded task pins at real-world locations |
| 💰 Escrow Wallet | Reward locked atomically when a task is posted; released to the assignee on confirmed completion |
| ⭐ Reputation | 1–5 star ratings per task; running average on every user profile |
| 🔍 Discovery | Full-text search + category chips (Help / Delivery / Social / Other) |
| 📱 Mobile-First | Safe-area insets, svh viewport units, bottom-sheet modals on touch devices |
| Page | Description |
|---|---|
| Installation | Clone, configure Firebase, deploy rules, serve locally |
| Usage | Post tasks, claim tasks, search, filter, manage your profile |
| Page | Description |
|---|---|
| Architecture | System design, component responsibilities, data flow, module internals |
| Privacy | Data collected, storage, retention, security rules, user rights |
| Page | Description |
|---|---|
| Contributing | Branch naming, commit style, coding conventions, review process |
| Roadmap | Planned features, version goals, long-term vision |
| Troubleshooting | Diagnosis flowcharts, common errors, debugging tools |
| Component | Technology | Version |
|---|---|---|
| Markup | HTML5 | — |
| Styling | Tailwind CSS | CDN latest |
| Scripting | Vanilla JavaScript ES Modules | ES2020+ |
| Map | MapLibre GL JS | 3.6.2 |
| Authentication | Firebase Auth | 10.7.1 |
| Database | Cloud Firestore | 10.7.1 |
| Hosting | Any static host | — |
Zero build step. No npm, no webpack. Clone → configure → open in browser.
# 1. Clone
git clone https://github.com/Kaelith69/SideQuest.git && cd SideQuest
# 2. Add your Firebase credentials to js/firebase-config.js
# 3. Deploy Firestore rules
firebase deploy --only firestore:rules
# 4. Serve
python -m http.server 8000
# 5. Open http://localhost:8000 → sign up → get ₹500 demo walletMIT License — Copyright © 2026 Kaelith69. See LICENSE.
Made with 💻 and ☕ by Kaelith69