A Rails application for community coordination, with native iOS and Android apps.
- Dashboard - Activity hub with unified timeline of upcoming events and meals, tasks, and documents
- Chat - Real-time messaging powered by Stream Chat
- Calendar - Event scheduling with Google Calendar integration
- Documents - Shared documents with Google Drive integration
- Tasks - Task management with assignments and completion tracking
- Meals - Community meal scheduling with cook signup and RSVPs
Conduit supports multiple isolated communities, each with their own domain, users, and data. This is implemented using the acts_as_tenant gem for automatic query scoping.
- Domain-based routing: Each community has a configured domain. The community is determined by
request.host(e.g.,conduit.crowwoods.comroutes to the "Crow Woods" community) - Data isolation: All queries are automatically scoped to the current community. Users, posts, meals, chores, etc. from one community are never visible to another
- Separate user accounts: The same email can exist in different communities as completely separate accounts
- Per-community settings: Each community can have its own Google Calendar ID, Google Drive folder, and other settings stored in the
settingsJSONB column
Community:
- name # Display name (e.g., "Crow Woods")
- slug # URL-friendly identifier (e.g., "crow-woods")
- domain # The domain for this community (e.g., "conduit.crowwoods.com")
- settings # JSONB for Google integration IDs, SMTP settings, etc.
- time_zone # Community's timezone (default: "America/New_York")In development, the app automatically uses the "crow-woods" community when accessing via localhost. This means you don't need to set up custom domains locally.
To create the initial community:
# Run the data migration task (creates "Crow Woods" community and associates existing data)
bin/rails multi_community:setupTo create additional communities:
# In rails console
Community.create!(
name: "My Community",
slug: "my-community",
domain: "my-community.localhost", # Or your production domain
settings: {
"google_calendar_id" => "your_calendar_id@group.calendar.google.com",
"google_drive_folder_id" => "your_folder_id"
}
)Testing with multiple communities locally:
-
Add entries to
/etc/hosts:127.0.0.1 community1.localhost 127.0.0.1 community2.localhost -
Create communities with those domains:
Community.create!(name: "Community 1", slug: "community-1", domain: "community1.localhost:3000") Community.create!(name: "Community 2", slug: "community-2", domain: "community2.localhost:3000")
-
Access each community at their respective URLs
Background jobs that process data across all communities (like meal reminders) automatically iterate over all communities:
Community.find_each do |community|
ActsAsTenant.with_tenant(community) do
# All queries inside this block are scoped to this community
end
end- Ruby 3.2.0 or higher
- PostgreSQL
- Node.js and Yarn
- Clone the repository
- Run
bundle installto install Ruby dependencies - Run
rails db:create db:migrateto set up the database - Copy
.env.exampleto.envand configure your environment variables - Start the server with
bin/dev
Create a .env file with the following:
# Google OAuth (required for authentication)
GOOGLE_CLIENT_ID=your_client_id
GOOGLE_CLIENT_SECRET=your_client_secret
# Stream Chat (required for chat functionality)
STREAM_API_KEY=your_stream_api_key
STREAM_API_SECRET=your_stream_api_secret
# SMTP Email (required for email notifications)
SMTP_USERNAME=your_email_address
SMTP_PASSWORD=your_email_password
# JWT Secret (required for mobile app authentication)
JWT_SECRET=your_jwt_secret
- Go to the Google Cloud Console
- Create a new project or select an existing one
- Navigate to "APIs & Services" > "Credentials"
- Click "Create Credentials" and select "OAuth client ID"
- Select "Web application" as the application type
- Add your callback URL to "Authorized redirect URIs":
- Development:
http://localhost:3000/auth/google_oauth2/callback - Production:
https://yourdomain.com/auth/google_oauth2/callback
- Development:
- Save the client ID and secret to your
.envfile
- Create an account at getstream.io
- Create a new Chat application
- Copy the API key and secret to your
.envfile - For push notifications:
- iOS: Configure APN certificates in Stream Dashboard
- Android: Upload Firebase service account JSON in Stream Dashboard
Email notifications (meal reminders, RSVP confirmations, etc.) are sent via SMTP. The default configuration uses Namecheap PrivateEmail, but any SMTP provider works.
- Use your domain email (e.g.,
info@yourcommunity.com) - Add to your
.envfile:SMTP_USERNAME=info@yourcommunity.com SMTP_PASSWORD=your_email_password
The SMTP server is configured as mail.privateemail.com on port 587.
To use a different provider, update config/initializers/email.rb with your SMTP settings:
| Provider | Server | Port |
|---|---|---|
| Gmail | smtp.gmail.com | 587 |
| Outlook | smtp.office365.com | 587 |
| SendGrid | smtp.sendgrid.net | 587 |
Note: Gmail requires an App Password (not your regular password).
The iOS app is located in the ios/ directory. See ios/README.md for setup instructions.
The Android app is located in the android/ directory.
cd android
./gradlew assembleReleaseCreate android/local.properties with:
STREAM_API_KEY=your_stream_api_key
GOOGLE_CLIENT_ID=your_web_client_idNote: The GOOGLE_CLIENT_ID should be your Web OAuth client ID (used for ID token verification).
For Google Sign-In, you'll also need to create Android OAuth clients in Google Cloud Console with your app's SHA-1 fingerprints.
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.
This means you are free to use, modify, and distribute this software, but if you run a modified version on a server and let others interact with it, you must make the source code available to them.