Commit ·
15cfc64
0
Parent(s):
Initial commit: CityTrack MVP with documentation, templates, and license
Browse files- .gitattributes +35 -0
- .github/CODE_OF_CONDUCT.md +37 -0
- .github/CONTRIBUTING.md +58 -0
- .github/FUNDING.yml +2 -0
- .github/ISSUE_TEMPLATE/BUG_REPORT.md +56 -0
- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +80 -0
- .github/PULL_REQUEST_TEMPLATE.md +93 -0
- .github/SECURITY.md +57 -0
- LICENSE +45 -0
- README.md +95 -0
.gitattributes
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
*.7z filter=lfs diff=lfs merge=lfs -text
|
| 2 |
+
*.arrow filter=lfs diff=lfs merge=lfs -text
|
| 3 |
+
*.bin filter=lfs diff=lfs merge=lfs -text
|
| 4 |
+
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
| 5 |
+
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
| 6 |
+
*.ftz filter=lfs diff=lfs merge=lfs -text
|
| 7 |
+
*.gz filter=lfs diff=lfs merge=lfs -text
|
| 8 |
+
*.h5 filter=lfs diff=lfs merge=lfs -text
|
| 9 |
+
*.joblib filter=lfs diff=lfs merge=lfs -text
|
| 10 |
+
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
| 11 |
+
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
| 12 |
+
*.model filter=lfs diff=lfs merge=lfs -text
|
| 13 |
+
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
| 14 |
+
*.npy filter=lfs diff=lfs merge=lfs -text
|
| 15 |
+
*.npz filter=lfs diff=lfs merge=lfs -text
|
| 16 |
+
*.onnx filter=lfs diff=lfs merge=lfs -text
|
| 17 |
+
*.ot filter=lfs diff=lfs merge=lfs -text
|
| 18 |
+
*.parquet filter=lfs diff=lfs merge=lfs -text
|
| 19 |
+
*.pb filter=lfs diff=lfs merge=lfs -text
|
| 20 |
+
*.pickle filter=lfs diff=lfs merge=lfs -text
|
| 21 |
+
*.pkl filter=lfs diff=lfs merge=lfs -text
|
| 22 |
+
*.pt filter=lfs diff=lfs merge=lfs -text
|
| 23 |
+
*.pth filter=lfs diff=lfs merge=lfs -text
|
| 24 |
+
*.rar filter=lfs diff=lfs merge=lfs -text
|
| 25 |
+
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
| 26 |
+
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 27 |
+
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 28 |
+
*.tar filter=lfs diff=lfs merge=lfs -text
|
| 29 |
+
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 30 |
+
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 31 |
+
*.wasm filter=lfs diff=lfs merge=lfs -text
|
| 32 |
+
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 33 |
+
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
+
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
+
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
.github/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Code of Conduct
|
| 2 |
+
|
| 3 |
+
## Our Commitment
|
| 4 |
+
|
| 5 |
+
We are committed to providing a welcoming and inclusive environment for all contributors, regardless of their background or experience level.
|
| 6 |
+
|
| 7 |
+
## Our Standards
|
| 8 |
+
|
| 9 |
+
Examples of behavior that contributes to creating a positive environment include:
|
| 10 |
+
|
| 11 |
+
- Being respectful and inclusive
|
| 12 |
+
- Using welcoming and inclusive language
|
| 13 |
+
- Being open to constructive criticism
|
| 14 |
+
- Focusing on what is best for the community
|
| 15 |
+
- Showing empathy toward others
|
| 16 |
+
|
| 17 |
+
Examples of unacceptable behavior include:
|
| 18 |
+
|
| 19 |
+
- Harassment or discrimination of any kind
|
| 20 |
+
- Trolling, insulting, or derogatory comments
|
| 21 |
+
- Unwelcome sexual attention
|
| 22 |
+
- Publishing private information
|
| 23 |
+
- Other conduct that could negatively impact others
|
| 24 |
+
|
| 25 |
+
## Enforcement
|
| 26 |
+
|
| 27 |
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at [@0xarchit](https://github.com/0xarchit).
|
| 28 |
+
|
| 29 |
+
All complaints will be reviewed and investigated fairly.
|
| 30 |
+
|
| 31 |
+
## Attribution
|
| 32 |
+
|
| 33 |
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
|
| 34 |
+
|
| 35 |
+
---
|
| 36 |
+
|
| 37 |
+
**Together, we build a better community.**
|
.github/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to CityTrack
|
| 2 |
+
|
| 3 |
+
Thank you for your interest in contributing to CityTrack! We welcome all contributions to help improve urban infrastructure reporting.
|
| 4 |
+
|
| 5 |
+
## Getting Started
|
| 6 |
+
|
| 7 |
+
1. Fork the repository
|
| 8 |
+
2. Clone your fork: `git clone https://github.com/0xarchit/CityTrack.git`
|
| 9 |
+
3. Create a feature branch: `git checkout -b feature/your-feature`
|
| 10 |
+
4. Make your changes
|
| 11 |
+
5. Push to your branch and open a Pull Request
|
| 12 |
+
|
| 13 |
+
## Development Setup
|
| 14 |
+
|
| 15 |
+
```bash
|
| 16 |
+
git clone https://github.com/0xarchit/CityTrack.git
|
| 17 |
+
cd CityTrack
|
| 18 |
+
docker-compose up -d
|
| 19 |
+
npm install && pip install -r requirements.txt
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
## Code Style
|
| 23 |
+
|
| 24 |
+
- Follow PEP 8 for Python code
|
| 25 |
+
- Use ESLint for JavaScript/TypeScript
|
| 26 |
+
- Write clear, meaningful commit messages
|
| 27 |
+
- Add tests for new features
|
| 28 |
+
|
| 29 |
+
## Pull Request Process
|
| 30 |
+
|
| 31 |
+
1. Update documentation if applicable
|
| 32 |
+
2. Add tests for new functionality
|
| 33 |
+
3. Ensure all tests pass locally
|
| 34 |
+
4. Provide a clear description of changes
|
| 35 |
+
5. Reference any related issues
|
| 36 |
+
|
| 37 |
+
## Reporting Bugs
|
| 38 |
+
|
| 39 |
+
Use GitHub Issues to report bugs. Include:
|
| 40 |
+
- Clear description of the bug
|
| 41 |
+
- Steps to reproduce
|
| 42 |
+
- Expected vs. actual behavior
|
| 43 |
+
- System information
|
| 44 |
+
|
| 45 |
+
## Suggesting Features
|
| 46 |
+
|
| 47 |
+
We're open to new ideas! Create an issue with:
|
| 48 |
+
- Clear feature description
|
| 49 |
+
- Use cases
|
| 50 |
+
- Any implementation suggestions
|
| 51 |
+
|
| 52 |
+
## Questions?
|
| 53 |
+
|
| 54 |
+
Feel free to open a discussion or issue if you have questions. We're here to help!
|
| 55 |
+
|
| 56 |
+
---
|
| 57 |
+
|
| 58 |
+
Built by BitBots | Team Lead: [@0xarchit](https://github.com/0xarchit)
|
.github/FUNDING.yml
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
|
|
|
|
|
|
|
| 1 |
+
github: 0xarchit
|
| 2 |
+
buy_me_a_coffee: 0xarchit
|
.github/ISSUE_TEMPLATE/BUG_REPORT.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: Bug Report
|
| 3 |
+
about: Report a bug you found in CityTrack
|
| 4 |
+
title: "[BUG] "
|
| 5 |
+
labels: bug
|
| 6 |
+
assignees: 0xarchit
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
## Description
|
| 10 |
+
Briefly describe the bug. What happened that shouldn't have?
|
| 11 |
+
|
| 12 |
+
## Reproduction Steps
|
| 13 |
+
Steps to reproduce the issue:
|
| 14 |
+
|
| 15 |
+
1. Go to...
|
| 16 |
+
2. Click on...
|
| 17 |
+
3. See error...
|
| 18 |
+
|
| 19 |
+
## Expected Behavior
|
| 20 |
+
What did you expect to happen?
|
| 21 |
+
|
| 22 |
+
## Actual Behavior
|
| 23 |
+
What actually happened instead?
|
| 24 |
+
|
| 25 |
+
## Environment
|
| 26 |
+
- **OS:** (e.g., Windows 10, macOS 13, Ubuntu 22.04)
|
| 27 |
+
- **Browser:** (e.g., Chrome 120, Firefox 121, Safari 17)
|
| 28 |
+
- **Component:** (e.g., Mobile App, Admin Dashboard, Backend API)
|
| 29 |
+
- **Version:** (e.g., v0.1.0)
|
| 30 |
+
- **Device:** (e.g., iPhone 14, Desktop)
|
| 31 |
+
|
| 32 |
+
## Screenshots or Logs
|
| 33 |
+
If applicable, add screenshots or error logs here:
|
| 34 |
+
|
| 35 |
+
```
|
| 36 |
+
Paste error message or log output here
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
## Additional Context
|
| 40 |
+
Add any other context about the problem here (network conditions, specific data, etc.)
|
| 41 |
+
|
| 42 |
+
## Priority
|
| 43 |
+
- [ ] Critical (App crash/data loss)
|
| 44 |
+
- [ ] High (Feature broken)
|
| 45 |
+
- [ ] Medium (Unexpected behavior)
|
| 46 |
+
- [ ] Low (Minor issue)
|
| 47 |
+
|
| 48 |
+
## Possible Solution
|
| 49 |
+
If you have suggestions on how to fix this, describe them here.
|
| 50 |
+
|
| 51 |
+
---
|
| 52 |
+
|
| 53 |
+
**Checklist:**
|
| 54 |
+
- [ ] I've searched existing issues to ensure this isn't a duplicate
|
| 55 |
+
- [ ] I've provided clear steps to reproduce
|
| 56 |
+
- [ ] I've included relevant environment information
|
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: Feature Request
|
| 3 |
+
about: Suggest a new feature or improvement for CityTrack
|
| 4 |
+
title: "[FEATURE] "
|
| 5 |
+
labels: enhancement
|
| 6 |
+
assignees: 0xarchit
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
## Description
|
| 10 |
+
Provide a clear and detailed description of the feature you'd like to see.
|
| 11 |
+
|
| 12 |
+
## Problem It Solves
|
| 13 |
+
What problem does this feature address? Why is it needed?
|
| 14 |
+
|
| 15 |
+
- Current workflow pain point:
|
| 16 |
+
- User frustration:
|
| 17 |
+
- Impact:
|
| 18 |
+
|
| 19 |
+
## Proposed Solution
|
| 20 |
+
Describe how you envision this feature working:
|
| 21 |
+
|
| 22 |
+
1. User would...
|
| 23 |
+
2. System would...
|
| 24 |
+
3. Result would be...
|
| 25 |
+
|
| 26 |
+
## Alternatives Considered
|
| 27 |
+
Have you thought of alternative solutions or features?
|
| 28 |
+
|
| 29 |
+
- Option A: ...
|
| 30 |
+
- Option B: ...
|
| 31 |
+
|
| 32 |
+
## Use Cases
|
| 33 |
+
Describe real-world scenarios where this feature would be useful:
|
| 34 |
+
|
| 35 |
+
**Use Case 1:**
|
| 36 |
+
- Actor: (e.g., Citizen, Worker, Admin)
|
| 37 |
+
- Action: ...
|
| 38 |
+
- Expected outcome: ...
|
| 39 |
+
|
| 40 |
+
**Use Case 2:**
|
| 41 |
+
- Actor: ...
|
| 42 |
+
- Action: ...
|
| 43 |
+
- Expected outcome: ...
|
| 44 |
+
|
| 45 |
+
## Affected Components
|
| 46 |
+
Which parts of CityTrack would this feature affect?
|
| 47 |
+
|
| 48 |
+
- [ ] Mobile App (Citizen)
|
| 49 |
+
- [ ] Admin Dashboard
|
| 50 |
+
- [ ] Worker Portal
|
| 51 |
+
- [ ] Backend API
|
| 52 |
+
- [ ] Database
|
| 53 |
+
- [ ] AI/ML Pipeline
|
| 54 |
+
|
| 55 |
+
## Acceptance Criteria
|
| 56 |
+
What would make this feature "done"?
|
| 57 |
+
|
| 58 |
+
- [ ] Criterion 1
|
| 59 |
+
- [ ] Criterion 2
|
| 60 |
+
- [ ] Criterion 3
|
| 61 |
+
|
| 62 |
+
## Additional Context
|
| 63 |
+
Add any other context, mockups, or references here.
|
| 64 |
+
|
| 65 |
+
## Priority
|
| 66 |
+
- [ ] Critical (Blocking other features)
|
| 67 |
+
- [ ] High (High user impact)
|
| 68 |
+
- [ ] Medium (Nice to have)
|
| 69 |
+
- [ ] Low (Enhancement)
|
| 70 |
+
|
| 71 |
+
## Related Issues
|
| 72 |
+
Link to any related issues: #123
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
**Checklist:**
|
| 77 |
+
- [ ] I've checked if this feature already exists
|
| 78 |
+
- [ ] I've searched for existing feature requests
|
| 79 |
+
- [ ] I've provided clear use cases
|
| 80 |
+
- [ ] The scope is well-defined
|
.github/PULL_REQUEST_TEMPLATE.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Pull Request: [Brief Title]
|
| 2 |
+
|
| 3 |
+
## Description
|
| 4 |
+
Please include a summary of the changes and related context. Why is this change being made?
|
| 5 |
+
|
| 6 |
+
## Type of Change
|
| 7 |
+
- [ ] Bug fix (non-breaking change which fixes an issue)
|
| 8 |
+
- [ ] New feature (non-breaking change which adds functionality)
|
| 9 |
+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
| 10 |
+
- [ ] Documentation update
|
| 11 |
+
- [ ] Performance improvement
|
| 12 |
+
- [ ] Code refactoring
|
| 13 |
+
- [ ] Testing enhancement
|
| 14 |
+
|
| 15 |
+
## Related Issue
|
| 16 |
+
Closes #(issue number)
|
| 17 |
+
|
| 18 |
+
## Changes Made
|
| 19 |
+
Describe the specific changes in this PR:
|
| 20 |
+
|
| 21 |
+
- Change 1: ...
|
| 22 |
+
- Change 2: ...
|
| 23 |
+
- Change 3: ...
|
| 24 |
+
|
| 25 |
+
## Testing
|
| 26 |
+
Describe what tests you've run and how to reproduce them:
|
| 27 |
+
|
| 28 |
+
### Test Cases
|
| 29 |
+
- [ ] Test case 1: ...
|
| 30 |
+
- [ ] Test case 2: ...
|
| 31 |
+
- [ ] Edge case: ...
|
| 32 |
+
|
| 33 |
+
### Manual Testing Steps
|
| 34 |
+
1. Step 1
|
| 35 |
+
2. Step 2
|
| 36 |
+
3. Expected result: ...
|
| 37 |
+
|
| 38 |
+
## Affected Components
|
| 39 |
+
Which parts of CityTrack are affected?
|
| 40 |
+
|
| 41 |
+
- [ ] Mobile App
|
| 42 |
+
- [ ] Admin Dashboard
|
| 43 |
+
- [ ] Worker Portal
|
| 44 |
+
- [ ] Backend API
|
| 45 |
+
- [ ] Database
|
| 46 |
+
- [ ] AI/ML Pipeline
|
| 47 |
+
- [ ] Documentation
|
| 48 |
+
- [ ] Other: ___________
|
| 49 |
+
|
| 50 |
+
## Breaking Changes
|
| 51 |
+
List any breaking changes and migration steps if applicable:
|
| 52 |
+
|
| 53 |
+
- Breaking change 1:
|
| 54 |
+
- Migration: ...
|
| 55 |
+
|
| 56 |
+
## Checklist
|
| 57 |
+
- [ ] My code follows the code style of this project
|
| 58 |
+
- [ ] I have performed a self-review of my own code
|
| 59 |
+
- [ ] I have commented my code, particularly in hard-to-understand areas
|
| 60 |
+
- [ ] I have made corresponding changes to the documentation
|
| 61 |
+
- [ ] My changes generate no new warnings
|
| 62 |
+
- [ ] I have added tests that prove my fix/feature works
|
| 63 |
+
- [ ] New and existing unit tests passed locally with my changes
|
| 64 |
+
- [ ] Any dependent changes have been merged and published
|
| 65 |
+
- [ ] I've updated the CHANGELOG (if applicable)
|
| 66 |
+
|
| 67 |
+
## Performance Impact
|
| 68 |
+
- [ ] No performance impact
|
| 69 |
+
- [ ] Performance improvement (describe: ...)
|
| 70 |
+
- [ ] Performance impact (describe: ... and why it's necessary)
|
| 71 |
+
|
| 72 |
+
## Security Considerations
|
| 73 |
+
Are there any security implications?
|
| 74 |
+
|
| 75 |
+
- [ ] No security concerns
|
| 76 |
+
- [ ] Security improvement (describe the fix: ...)
|
| 77 |
+
- [ ] Requires security review (describe the change: ...)
|
| 78 |
+
|
| 79 |
+
## Screenshots (if applicable)
|
| 80 |
+
Add screenshots for UI changes:
|
| 81 |
+
|
| 82 |
+
| Before | After |
|
| 83 |
+
|--------|-------|
|
| 84 |
+
| [Screenshot] | [Screenshot] |
|
| 85 |
+
|
| 86 |
+
## Additional Notes
|
| 87 |
+
Any additional information reviewers should know?
|
| 88 |
+
|
| 89 |
+
---
|
| 90 |
+
|
| 91 |
+
**Reviewer Notes:**
|
| 92 |
+
- Review focus areas: ...
|
| 93 |
+
- Questions for reviewers: ...
|
.github/SECURITY.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Security Policy
|
| 2 |
+
|
| 3 |
+
## Reporting a Vulnerability
|
| 4 |
+
|
| 5 |
+
We take security vulnerabilities seriously. If you discover a security issue, please follow responsible disclosure practices:
|
| 6 |
+
|
| 7 |
+
**Do not open a public GitHub issue for security vulnerabilities.**
|
| 8 |
+
|
| 9 |
+
Instead, email your findings directly to the team lead:
|
| 10 |
+
- **Archit Jain** (@0xarchit) - Team Lead
|
| 11 |
+
|
| 12 |
+
Include:
|
| 13 |
+
- Description of the vulnerability
|
| 14 |
+
- Steps to reproduce (if applicable)
|
| 15 |
+
- Potential impact
|
| 16 |
+
- Suggested fix (if you have one)
|
| 17 |
+
|
| 18 |
+
## Security Best Practices
|
| 19 |
+
|
| 20 |
+
When contributing to CityTrack, please follow these security guidelines:
|
| 21 |
+
|
| 22 |
+
### Authentication & Authorization
|
| 23 |
+
- Never hardcode credentials or API keys
|
| 24 |
+
- Use environment variables for sensitive data
|
| 25 |
+
- Implement proper role-based access control (RBAC)
|
| 26 |
+
|
| 27 |
+
### Data Protection
|
| 28 |
+
- All images and GPS data must be encrypted in transit (HTTPS/TLS)
|
| 29 |
+
- User authentication must use [Supabase Auth](https://supabase.com)
|
| 30 |
+
- Implement rate limiting on API endpoints
|
| 31 |
+
|
| 32 |
+
### Code
|
| 33 |
+
- Keep dependencies updated
|
| 34 |
+
- Run security audits regularly
|
| 35 |
+
- Use parameterized queries to prevent SQL injection
|
| 36 |
+
- Validate all user inputs
|
| 37 |
+
|
| 38 |
+
### Infrastructure
|
| 39 |
+
- Deploy in secure, containerized environments
|
| 40 |
+
- Use environment variables for configuration
|
| 41 |
+
- Implement proper logging and monitoring
|
| 42 |
+
- Regular security updates for all services
|
| 43 |
+
|
| 44 |
+
## Supported Versions
|
| 45 |
+
|
| 46 |
+
- **MVP Release (v0.1.x):** Security updates will be provided
|
| 47 |
+
|
| 48 |
+
## Disclosure Timeline
|
| 49 |
+
|
| 50 |
+
- **Report:** Contact the team immediately
|
| 51 |
+
- **Acknowledgment:** Within 48 hours
|
| 52 |
+
- **Fix & Release:** Target 7-14 days for critical issues
|
| 53 |
+
- **Public Disclosure:** After fix is released
|
| 54 |
+
|
| 55 |
+
---
|
| 56 |
+
|
| 57 |
+
Thank you for helping keep CityTrack secure!
|
LICENSE
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2026 BitBots Team
|
| 4 |
+
|
| 5 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 6 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 7 |
+
in the Software without restriction, including without limitation the rights
|
| 8 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 9 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 10 |
+
furnished to do so, subject to the following conditions:
|
| 11 |
+
|
| 12 |
+
The above copyright notice and this permission notice shall be included in all
|
| 13 |
+
copies or substantial portions of the Software.
|
| 14 |
+
|
| 15 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 16 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 17 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 18 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 19 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 20 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 21 |
+
SOFTWARE.
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
|
| 25 |
+
## Summary
|
| 26 |
+
|
| 27 |
+
You are free to:
|
| 28 |
+
- **Use** the software for any purpose, commercial or non-commercial
|
| 29 |
+
- **Copy, modify, and distribute** the software
|
| 30 |
+
- **Include** the software in proprietary applications
|
| 31 |
+
|
| 32 |
+
You must:
|
| 33 |
+
- **Include a copy** of this license and copyright notice in any distribution
|
| 34 |
+
- **State significant changes** made to the software
|
| 35 |
+
|
| 36 |
+
You cannot:
|
| 37 |
+
- Hold the authors liable for any issues that arise from using this software
|
| 38 |
+
- Use the authors' or contributors' names to endorse derivative works without permission
|
| 39 |
+
|
| 40 |
+
## Contributors
|
| 41 |
+
|
| 42 |
+
**Team Lead:** Archit Jain (@0xarchit)
|
| 43 |
+
**Contributors:** Rachit Verma (@vxrachit), Pushpendra Sharma (@synapticpush), Deepti Yadav (@DeeptiYadav10648)
|
| 44 |
+
|
| 45 |
+
Built by BitBots | HackTheThrone 2026
|
README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: citytrack
|
| 3 |
+
emoji: 🌆
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
pinned: true
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# CityTrack
|
| 12 |
+
|
| 13 |
+
> **Governance at the Speed of Software**
|
| 14 |
+
|
| 15 |
+
CityTrack is an AI-powered urban issue reporting and management platform that transforms how cities handle infrastructure problems. Citizens report issues with AI validation, and autonomous agents route them to the right departments in real-time.
|
| 16 |
+
|
| 17 |
+
## Quick Overview
|
| 18 |
+
|
| 19 |
+
**The Problem:** Traditional city issue reporting systems are slow, manual, and prone to duplicates.
|
| 20 |
+
|
| 21 |
+
**The Solution:** CityTrack uses AI agents to instantly validate, deduplicate, and intelligently route urban issues—turning citizens into real-time sensors for city infrastructure.
|
| 22 |
+
|
| 23 |
+
## Key Features (MVP)
|
| 24 |
+
|
| 25 |
+
- 📸 **Live Camera Capture:** Mandatory camera verification to prevent fake reports
|
| 26 |
+
- 📍 **GPS Validation:** High-precision location data (< 10m accuracy)
|
| 27 |
+
- 🤖 **AI Issue Classification:** Automatic detection of potholes, debris, and damaged infrastructure
|
| 28 |
+
- 🔄 **Smart Deduplication:** Groups similar reports and prevents redundant tickets
|
| 29 |
+
- 👷 **Worker Dashboard:** Task list with instant notifications and routing
|
| 30 |
+
- 📱 **Citizen Tracking:** Real-time updates on report status
|
| 31 |
+
|
| 32 |
+
## Getting Started
|
| 33 |
+
|
| 34 |
+
### Prerequisites
|
| 35 |
+
- Node.js 20+
|
| 36 |
+
- Python 3.11+
|
| 37 |
+
- Docker & Docker Compose
|
| 38 |
+
- PostgreSQL with PostGIS extension
|
| 39 |
+
|
| 40 |
+
### Installation
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
git clone https://github.com/0xarchit/CityTrack.git
|
| 44 |
+
cd CityTrack
|
| 45 |
+
|
| 46 |
+
docker-compose up -d
|
| 47 |
+
|
| 48 |
+
npm install
|
| 49 |
+
pip install -r requirements.txt
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
### Running the Project
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
docker-compose up
|
| 56 |
+
|
| 57 |
+
npm run dev # Frontend
|
| 58 |
+
python main.py # Backend
|
| 59 |
+
```
|
| 60 |
+
|
| 61 |
+
## Tech Stack
|
| 62 |
+
|
| 63 |
+
- **Backend:** FastAPI, Python, SQLAlchemy, PostgreSQL
|
| 64 |
+
- **Frontend:** Next.js, Tailwind CSS
|
| 65 |
+
- **Mobile:** React Native, Expo
|
| 66 |
+
- **AI/ML:** YOLOv8 (Issue Detection)
|
| 67 |
+
- **Authentication:** Supabase
|
| 68 |
+
- **Infrastructure:** Docker
|
| 69 |
+
|
| 70 |
+
## The Autonomous Pipeline
|
| 71 |
+
|
| 72 |
+
1. **Vision Agent** → Validates and classifies uploaded images
|
| 73 |
+
2. **Geo-Dedup Agent** → Merges duplicate reports in the same area
|
| 74 |
+
3. **Priority Agent** → Assigns urgency levels based on context
|
| 75 |
+
4. **Routing Agent** → Matches issues to departments and workers
|
| 76 |
+
5. **Notification Agent** → Sends updates to all stakeholders
|
| 77 |
+
|
| 78 |
+
## Contributing
|
| 79 |
+
|
| 80 |
+
We welcome contributions! Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
|
| 81 |
+
|
| 82 |
+
## Team
|
| 83 |
+
|
| 84 |
+
Built by **BitBots** at IIIT Una, HackTheThrone 2026
|
| 85 |
+
|
| 86 |
+
| Role | Name | GitHub |
|
| 87 |
+
|------|------|--------|
|
| 88 |
+
| Lead Developer | Archit Jain | [@0xarchit](https://github.com/0xarchit) |
|
| 89 |
+
| Developer | Rachit Verma | [@vxrachit](https://github.com/vxrachit) |
|
| 90 |
+
| Developer | Pushpendra Sharma | [@synapticpush](https://github.com/synapticpush) |
|
| 91 |
+
| Developer | Deepti Yadav | [@DeeptiYadav10648](https://github.com/DeeptiYadav10648) |
|
| 92 |
+
|
| 93 |
+
## License
|
| 94 |
+
|
| 95 |
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|