A digital community hub platform designed to support newcomers in unfamiliar cities by enabling them to borrow, share, and reserve essential items while connecting with Leads, Circles, Crews, and local hubs.
# Start with Docker (recommended)
scripts\docker.bat start # Windows
./scripts/docker.sh start # Mac/Linux
# Visit http://localhost:8000/api/docs/
# Login: admin@flokr.com / admin123flokr/
├── backend/ # Django REST API
│ ├── flokr/ # Main Django project
│ ├── users/ # User management & notifications
│ ├── inventory/ # Inventory management
│ ├── reservations/ # Reservation system & Celery tasks
│ ├── hubs/ # Hub management
│ ├── community/ # Community features (future)
│ ├── partners/ # Partner management (future)
│ └── manage.py
├── frontend/ # Next.js 15 web app (desktop/tablet)
│ └── src/
│ ├── app/ # App Router pages
│ ├── components/ # UI components
│ ├── lib/ # API client & utilities
│ └── store/ # Redux store
├── mobile/ # Expo React Native app (iOS/Android)
│ └── src/
│ ├── api/ # API client & services
│ ├── navigation/ # Navigation config
│ ├── screens/ # Screen components
│ └── store/ # Redux store
├── scripts/ # Utility scripts
│ ├── checkpoint.bat # Windows checkpoint verification
│ ├── checkpoint.sh # Mac/Linux checkpoint verification
│ ├── run_tests.py # Test runner
│ └── setup-backend.sh # Backend setup script
└── docs/ # Documentation
├── setup.md # Setup guide (all platforms)
├── checkpoint-1.md # Checkpoint 1 verification
├── requirements.md # Feature requirements
├── design.md # System design
└── tasks.md # Implementation tasks
- Python 3.11+ (or Conda)
- PostgreSQL 15+ with PostGIS extension
- Redis 7+
- Node.js 18+
- npm or yarn
- Node.js 18+
- Expo CLI
- iOS Simulator (Mac) or Android Studio
# Backend
./scripts/setup-backend.sh
conda activate flokr
# Start services
docker-compose up -d
# Run checkpoint
./scripts/checkpoint.sh # Mac/Linux
scripts\checkpoint.bat # WindowsSee detailed instructions in docs/setup.md
Docker (Recommended):
./scripts/docker.sh [start|stop|test|logs|shell]Other Scripts:
setup-backend.sh- Initial backend setupcheckpoint.sh- Verify milestone completionrun_tests.py- Run backend tests
See DOCKER.md and scripts/README.md for details.
# Backend - All tests
python scripts/run_tests.py
# Backend - Specific app
python scripts/run_tests.py users
# Frontend
cd frontend && npm test
# Mobile
cd mobile && npm test- Django 4.2+ with Django REST Framework
- PostgreSQL with PostGIS for geospatial data
- Redis for caching and Celery broker
- Celery for background tasks
- JWT authentication
- Next.js 15 with App Router
- TypeScript (strict mode)
- shadcn/ui component library
- Tailwind CSS with custom warm design system
- Redux Toolkit for state management
- Framer Motion for animations
- Axios for API calls
- Expo SDK 49+
- React Native
- Redux Toolkit for state management
- React Navigation
- Axios for API calls
- User authentication and role-based access control
- Inventory management across multiple hubs
- Reservation and borrowing system
- Community features (badges, feedback, Leads, Loop, Signals, Circles, and Moves)
- Partner organization support
- Navi community guide integration (planned)
- Push notifications
- Geospatial hub assignment
- Setup Guide - Complete setup for backend, frontend, and mobile
- Product Vision - fLOKr's unified community operating system direction
- Merge Plan - Focused fLOKr + RiseUp migration strategy
- Naming System - Loop, Signals, Circles, Crews, Leads, Moves, and Shifts
- Information Architecture - MVP navigation and route structure
- Roadmap - Merge roadmap and follow-up work
- Data Model Notes - Safe product-language aliases over risky table renames
- Migration Notes - What was and was not ported from RiseUp
- Changelog - Project progress, version history, and checkpoint verification
- Requirements - Feature requirements
- Design Document - System architecture and design
- Implementation Tasks - Task breakdown
See LICENSE file for details.