Skip to content

Commit dcaa721

Browse files
committed
readme - add themes
1 parent b9f5adf commit dcaa721

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ A production-ready Ruby on Rails boilerplate for building multi-tenant SaaS appl
1616
- **Subscription Management**: Integrated Stripe payments via Pay gem
1717
- **Team Management**: Organization creation, member invitations, and role management
1818
- **Modern UI**: Clean, responsive design that you can easily extend
19+
- **Dark mode & Themes**
1920

2021
> 💡 **Teams as MVP**: [Teams should be an MVP feature!](https://blog.bullettrain.co/teams-should-be-an-mvp-feature/) - Learn why implementing teams early is crucial for SaaS applications.
2122
@@ -166,6 +167,26 @@ The Stripe webhook listener is already configured in `Procfile.dev`
166167
stripe listen --forward-to localhost:3000/pay/webhooks/stripe
167168
```
168169

170+
## 🎨 Theme Configuration
171+
172+
Moneygun comes with built-in support for multiple themes. The application supports:
173+
174+
- **Default Theme**: Light mode with gray background
175+
- **Midnight Theme**: Dark mode with a sleek, modern look
176+
- **GitHub Theme**: GitHub-inspired color scheme
177+
178+
### Switching Themes
179+
180+
Themes can be applied by adding the appropriate class to the HTML element:
181+
182+
```html
183+
<html lang="en" class="h-full bg-gray-50 text-gray-900"></html>
184+
<!-- Dark midnight theme -->
185+
<html lang="en" class="h-full bg-gray-50 text-gray-900 midnight"></html>
186+
<!-- Dark GitHub theme -->
187+
<html lang="en" class="h-full bg-gray-50 text-gray-900 github"></html>
188+
```
189+
169190
#### Require active subscription to access a resource
170191

171192
You can use the `require_subscription` before_action to protect routes:
@@ -271,7 +292,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
271292

272293
## 🙏 Acknowledgments
273294

274-
- Design inspiration from Basecamp, Trello, Discord, and Slack
275-
- [Bullet Train](https://bullettrain.co/) for SaaS patterns and inspiration
276-
- [Jumpstart Pro](https://jumpstartrails.com/) for AccountMiddleware and other SaaS patterns
277-
- [gem "pay"](https://github.com/jumpstart-pro/pay) gem for Stripe integration
295+
- Design inspiration from Basecamp, Linear, Trello, Discord, and Slack
296+
- [Bullet Train](https://bullettrain.co/) for SaaS patterns and inspiration (obfuscates_id, super scaffolding, teams architecture)
297+
- [Jumpstart Pro](https://jumpstartrails.com/) & co for maintaining the magnificent gems [pay](http://github.com/pay-rails/pay), [acts_as_tenant](https://github.com/ErwinM/acts_as_tenant)

0 commit comments

Comments
 (0)