Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yshmarov/moneygun
Rails Multitenancy boilerplate. Users-Memberships-Organizations. Row-based. Set tenant based on URL params by default
https://github.com/yshmarov/moneygun
boilerplate multitenancy
Last synced: 37 minutes ago
JSON representation
Rails Multitenancy boilerplate. Users-Memberships-Organizations. Row-based. Set tenant based on URL params by default
- Host: GitHub
- URL: https://github.com/yshmarov/moneygun
- Owner: yshmarov
- License: mit
- Created: 2024-08-05T16:24:44.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T15:37:07.000Z (12 days ago)
- Last Synced: 2025-01-29T13:51:22.080Z (7 days ago)
- Topics: boilerplate, multitenancy
- Language: Ruby
- Homepage:
- Size: 1.14 MB
- Stars: 94
- Watchers: 7
- Forks: 8
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rails 8 Multitenancy Boilerplate
### Core features
- ✅ Registrations & Authentication (Devise + Devise invitable, but is quite easy to switch)
- ✅ Create Organizations (aka Teams, Accounts, Workspaces, Tenants)
- ✅ Invite Users to Organization & assign role (admin, member).
- ✅ Organization admin can manage organization & members
- ✅ Authorization
- ✅ Complete test coverage
- ✅ Basic UI design
- ✅ Nested scaffold generators for fast development (/organizations/projects)
### About Row-level route-based multitenancy in Ruby on Rails
[Teams should be an MVP feature!](https://blog.bullettrain.co/teams-should-be-an-mvp-feature/)
[Watch Screencast](https://www.youtube.com/watch?v=KMonLTvWR5g):
### Why route-based multitenancy?
- ✅ Easy to switch between organizations
- ✅ Keep multiple organizations open in different tabs
- ✅ No hassle configuring subdomains
### Why deep nested routes?
Yes, this can generate an "long" url like `/organizations/344/projects/4532/tasks/24342342/edit`, but it preserves the logical **hierarchy**.
```ruby
resources :organizations do
resources :memberships
resources :projects do
resources :tasks do
end
end
end
```
I [tried using `OrganizationMiddlewhare`](https://github.com/yshmarov/askvote/pull/24/files#diff-44009a2f9efdafcc7cd44e1cb5e03151a74aa760c54af5c16e2cc7095ff3b0ffR7) like JumpstartPro does, but it felt too much of an **unconventional** approach.
### Design inspiration
- trello
- discord
- slack
- https://circle.so/
For example in Trello, you can have 2 unrelated boards open in 2 tabs.
## Development
### Getting started
1. Clone the template repository:
```
git clone [email protected]:yshmarov/moneygun.git your_new_project_name
```
2. Enter the project directory:
```
cd your_new_project_name
```
3. Run the configuration and setup scripts:
```
bundle install
rails db:create db:migrate
```
4. Start your application:
```
bin/dev
```
### Resource assignments and references should be to Membership and not User!
🚫 Bad
```ruby
# models/project.rb
belongs_to :organization
belongs_to :user
```
✅ Good
```ruby
# models/project.rb
belongs_to :organization
belongs_to :membership
```
I recommend scoping downstream models to `organization` too. This way you can query them more easily.
```ruby
# models/task.rb
belongs_to :organization # <- THIS
belongs_to :project
```
### Generators
`Inbox` is an example of a well-integrated **resource** scoped to an `organization`. With pundit authorization and tests. Use it as an inspiration.
To quickly generate nested resources you can use [gem nested_scaffold](https://github.com/yshmarov/nested_scaffold)
```
rails generate nested_scaffold organization/project name
```
Generate a pundit policy:
```
rails g pundit:policy project
```
### Testing & linting
I did not focus on system tests, because the frontend can evolve a lot.
There are quite a lot of tests covering authentication, authorization, and multitenancy.
```shell
# run all tests
rails test:all
bundle exec erb_lint --lint-all -a
bundle exec rubocop -A
```
### Contributing
Feel free to raise an Issue or open a Pull Request!