open-navigator / README_HF.md
jcbowyer's picture
Clean HuggingFace deployment without binary files
61d29fc
---
title: CommunityOne - Open Navigator
emoji: πŸ›οΈ
colorFrom: blue
colorTo: green
sdk: docker
app_port: 7860
pinned: false
license: apache-2.0
tags:
- civic-engagement
- policy-tracking
- government-transparency
- nonprofit-discovery
- open-data
---
# πŸ›οΈ CommunityOne - Open Navigator
**Track 90,000+ jurisdictions. Monitor 1.8M nonprofits. Amplify your voice.**
CommunityOne is a civic engagement platform that helps you discover advocacy opportunities, track policy changes, and connect with organizations working on the causes you care about.
## ✨ Features
- **πŸ” Unified Search**: Find contacts, meetings, organizations, and causes across the entire United States
- **πŸ“Š Real-time Stats**: Track policy activity across 90,000+ cities, counties, and states
- **🏒 Nonprofit Discovery**: Explore 1.8M organizations from IRS data enriched with Every.org
- **πŸ“… Meeting Minutes**: Search 250,000+ government meeting transcripts and agendas
- **🎯 Geographic Filtering**: Browse by state, county, or city to find local opportunities
- **πŸ” OAuth Login**: Sign in with HuggingFace, GitHub, or Google to save your preferences
## πŸš€ Three Services Architecture
This deployment runs three integrated services:
1. **πŸ“š Documentation** (Docusaurus) - `/docs/`
2. **πŸ–₯️ Main Application** (React + Vite) - `/`
3. **⚑ API Backend** (FastAPI) - `/api/`
All services are reverse-proxied through nginx on port 7860.
## πŸ“– Quick Start
### Browse Without Login
- Click "Browse All" to explore data by state
- Use the search bar to find organizations, contacts, or causes
- Filter by location using the state/county/city selectors
### Sign In for Personalization
- Click "Login" in the top right
- Choose your OAuth provider (HuggingFace, GitHub, or Google)
- Follow organizations, leaders, and causes you care about
- Get personalized recommendations
### Explore the API
- Visit `/redoc` for interactive API documentation
- Try the search endpoints with state filters
- Export data in JSON format for your own projects
## πŸ› οΈ Technology Stack
- **Frontend**: React 18 + TypeScript + Vite + TailwindCSS + shadcn/ui
- **Backend**: Python 3.11 + FastAPI + Pydantic
- **Data**: Delta Lake + Parquet (90GB+ of civic data)
- **Docs**: Docusaurus v3
- **Infrastructure**: nginx + supervisor + Docker
## πŸ“Š Data Sources
- **IRS BMF**: 1.8M tax-exempt organizations
- **Every.org**: Nonprofit enrichment (logos, causes, revenue)
- **Open States**: State legislators and bills (7,300+ officials)
- **Census**: Jurisdictions and boundaries (90,000+)
- **CityScrapers**: Local government meetings
- **OpenCivicData**: Standardized government data
## πŸ”— Links
- **Repository**: [github.com/getcommunityone/open-navigator](https://github.com/getcommunityone/open-navigator)
- **Documentation**: Click "πŸ“š Browse Documentation" on the homepage
- **API Docs**: `/redoc` endpoint
- **Website**: [www.communityone.com](https://www.communityone.com)
## πŸ“ License
Apache License 2.0 - Free for commercial and non-commercial use
## 🀝 Contributing
We welcome contributions! See CONTRIBUTING.md in the repository for guidelines.
## πŸ’¬ Support
- **Issues**: [GitHub Issues](https://github.com/getcommunityone/open-navigator/issues)
- **Discussions**: [GitHub Discussions](https://github.com/getcommunityone/open-navigator/discussions)
- **Email**: hello@communityone.com
---
Built with ❀️ for civic engagement and government transparency.