A comprehensive community management platform for the Soralia Village residential community, featuring resident directory, community services marketplace, real estate agent marketplace, and real-time messaging.
- Community Directory: Browse and search all residents
- Advanced Filtering: Filter by role, street, interests
- Profile Management: Detailed resident profiles with contact information
- Grid/List Views: Multiple viewing options for different preferences
- Service Listings: Community members can offer services (gardening, plumbing, electrical, cleaning, etc.)
- Service Categories: Organized by service type with professional verification
- Provider Ratings: Review and rating system for service quality
- Service Types: Community services, member services, trusted third-party providers
- Admin Moderation: Content moderation and quality assurance
- Verified Agents: EAAB-registered real estate professionals
- Property Listings: Create and manage property listings for sale/rent
- Commission Tracking: Transparent commission management
- Agent Verification: Background checks and licensing verification
- Premium Features: Advanced portfolio management for property investors
- Direct Messaging: Private conversations between residents
- Real-Time Updates: Instant message delivery via Supabase Realtime
- Unread Indicators: Visual notifications for new messages
- Message History: Persistent conversation history
- Read Receipts: Track message delivery and read status
- User Management: Resident account administration
- Content Moderation: Review and approve service listings
- Analytics Dashboard: Platform usage statistics and insights
- System Configuration: Platform settings and maintenance
| Layer | Technology | Purpose |
|---|---|---|
| Frontend | Next.js 15, React 18, TypeScript | Modern React framework with type safety |
| Styling | TailwindCSS, PostCSS | Utility-first CSS framework |
| Backend | Next.js API Routes | Serverless API endpoints |
| Database | PostgreSQL | Primary data storage |
| ORM | Prisma 5 | Type-safe database access |
| Authentication | Better Auth | Secure user authentication |
| Real-Time | Supabase Realtime | Live messaging and notifications |
| Deployment | Vercel | Global CDN and serverless deployment |
| Testing | Vitest, Playwright | Unit and E2E testing |
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ Next.js App │────│ API Routes │────│ PostgreSQL │
│ │ │ │ │ (Prisma) │
│ • Pages │ │ • REST APIs │ │ │
│ • Components │ │ • Auth │ │ • Users │
│ • State Mgmt │ │ • Realtime │ │ • Conversations │
│ │ │ • File Upload │ │ • Services │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│ │ │
└───────────────────────┼───────────────────────┘
│
┌─────────────────┐
│ Supabase │
│ Realtime │
│ │
│ • Chat Messages │
│ • Notifications │
└─────────────────┘
- ResidentCard: Reusable component for displaying resident information
- ServiceCard: Component for service listings with provider details
- UnifiedResidentCard: Combined component with chat functionality
- DirectoryGrid: Main directory browsing interface
- ChatModal: Real-time messaging interface
- AdminDashboard: Administrative controls and analytics
- Node.js 18+ and npm
- PostgreSQL database (local or Supabase)
- Supabase account for real-time features
Clone the repository
git clone https://github.com/your-org/soralia-village.git cd soralia-villageInstall dependencies
npm install
Environment setup
cp .env.example .env.local
Configure your environment variables:
# DatabaseDATABASE_URL="postgresql://user:password@localhost:5432/soralia_village"# AuthenticationNEXT_PUBLIC_BETTER_AUTH_URL="http://localhost:3000"BETTER_AUTH_SECRET="your-secret-key"# Real-time (Supabase)NEXT_PUBLIC_SUPABASE_URL="your-supabase-url"NEXT_PUBLIC_SUPABASE_ANON_KEY="your-supabase-anon-key"
Database setup
# Push schema to database npm run db:push # Seed with sample data npm run db:seed
Start development server
npm run dev
Open your browser
http://localhost:3000
- Register/Login: Create your account or sign in
- Complete Profile: Add your contact information and interests
- Browse Directory: Discover other residents and community services
- Connect: Start conversations with other community members
- Access Services: Browse and book community services
- Create Listings: Add your services to the marketplace
- Manage Availability: Set your service hours and areas
- Respond to Inquiries: Handle booking requests from residents
- Build Reputation: Earn reviews and ratings
- Access Premium Features: Upgrade to Premium Seat
- Manage Portfolio: Track multiple properties
- Connect with Agents: Work with verified real estate professionals
- List Properties: Create property listings for sale/rent
- Access Admin Panel: Use admin dashboard for oversight
- Moderate Content: Review and approve service listings
- Manage Users: Handle resident accounts and permissions
- View Analytics: Monitor platform usage and performance
# Development
npm run dev # Start development server
npm run build # Build for production
npm run start # Start production server# Database
npm run db:push # Push schema changes to database
npm run db:seed # Seed database with sample data
npm run db:studio # Open Prisma Studio# Testing
npm test# Run tests in watch mode
npm run test:run # Run tests once
npm run test:coverage # Run tests with coverage# Code Quality
npm run lint # Run ESLint
npm run typecheck # Run TypeScript type checking
npm run format # Format code with Prettiersoralia-village/
├── src/
│ ├── app/ # Next.js app router
│ │ ├── api/ # API routes
│ │ ├── auth/ # Authentication pages
│ │ ├── dashboard/ # User dashboard
│ │ ├── directory/ # Community directory
│ │ └── messages/ # Messaging interface
│ ├── components/ # React components
│ │ ├── shared/ # Reusable components
│ │ ├── directory/ # Directory-specific components
│ │ ├── services/ # Service marketplace components
│ │ └── chat/ # Chat components
│ └── lib/ # Utilities and configurations
│ ├── auth.ts # Authentication setup
│ ├── prisma.ts # Database client
│ └── schemas.ts # Validation schemas
├── prisma/
│ ├── schema.prisma # Database schema
│ └── seed.ts # Database seeding
├── docs/ # Documentation
├── public/ # Static assets
└── package.json
The project includes comprehensive testing coverage:
npm run test# Run tests in watch mode
npm run test:run # Run all tests once
npm run test:coverage # Generate coverage reportnpx playwright test# Run E2E tests
npx playwright show-report # View test resultsSee TESTING_METHODS.md for comprehensive testing strategies.
POST /api/auth/sign-in # User login
POST /api/auth/sign-up # User registration
POST /api/auth/sign-out # User logout
GET /api/auth/session # Get current session
GET /api/users # List users (with filtering)
GET /api/users/[id] # Get user details
PUT /api/users/[id] # Update user profile
DELETE /api/users/[id] # Delete user (admin only)
GET /api/community-services/listings # Browse services
POST /api/community-services/listings # Create service listing
GET /api/community-services/listings/[id] # Get service details
PUT /api/community-services/listings/[id] # Update listing
DELETE /api/community-services/listings/[id] # Delete listing
POST /api/community-services/listings/[id]/publish # Publish/unpublish
GET /api/community-services/reviews/[listingId] # Get reviews
POST /api/community-services/reviews/[listingId] # Add review
POST /api/community-services/inquiries # Create service inquiry
GET /api/messages?conversationId=<id> # Get messages
POST /api/messages # Send message
GET /api/messages/unread # Get unread counts
POST /api/messages/mark-read # Mark as read
POST /api/conversations/find # Find/create conversation
GET /api/conversations/[id] # Get conversation details
GET /api/admin/users # List all users
GET /api/admin/analytics # Platform analytics
POST /api/admin/services/moderate/[id] # Moderate content
We welcome contributions to the Soralia Village platform!
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature-name - Make your changes following our coding standards
- Run tests:
npm run test:run - Commit your changes:
git commit -m "Add your feature" - Push to your fork:
git push origin feature/your-feature-name - Create a Pull Request
- TypeScript: Strict type checking enabled
- ESLint: Airbnb configuration with TypeScript support
- Prettier: Consistent code formatting
- Testing: Minimum 80% test coverage required
type(scope): description
[optional body]
[optional footer]
Types: feat, fix, docs, style, refactor, test, chore
This project is proprietary software owned by Netbones Solutions Pty Ltd. All rights reserved.
See SaaS_License_Agreement_Soralia_v4.md for detailed licensing terms.
- Documentation: docs/ directory
- Issues: GitHub Issues for bug reports and feature requests
- Discussions: GitHub Discussions for questions and community support
- Email: support@soralia.org
- Admin Portal: Available for authorized HOA administrators
- Emergency: For critical system issues
- Project Lead: Netbones Solutions Development Team
- Architecture: See CHAT_DESIGN.md
- Testing: See TESTING_METHODS.md
- ✅ Resident directory with advanced filtering
- ✅ Community services marketplace
- ✅ Real estate agent marketplace
- ✅ Real-time messaging system
- ✅ Admin moderation tools
- 📱 Mobile App: Native iOS/Android applications
- 📊 Advanced Analytics: Detailed usage and engagement metrics
- 🎯 Push Notifications: Browser and mobile push notifications
- 📅 Event Management: Community event planning and RSVPs
- 💰 Payment Integration: In-app payments for premium services
- 🌐 Multi-language: Additional language support
- ♿ Enhanced Accessibility: WCAG 2.1 AAA compliance
- 🏢 Multi-Community Support: Platform for multiple communities
- 🤖 AI Features: Smart recommendations and automated moderation
- 📈 Advanced Reporting: Comprehensive business intelligence
- 🔗 Third-party Integrations: External service provider connections
- 🎮 Gamification: Community engagement incentives
Built with ❤️ for the Soralia Village community
Empowering communities through technology since 2024