@okjavis/nodebb-theme-javis
v5.0.8
Published
Modern, premium NodeBB theme for JAVIS Community - Extends Harmony with custom styling
Readme
JAVIS Community Theme
A modern, premium NodeBB theme for JAVIS Community. Inspired by the clean aesthetics of Apple, Stripe, and Linear design systems.
Features
- Design System First: Built on a comprehensive design token system for consistency
- Modern Aesthetics: Clean, premium look with smooth interactions
- Fully Customizable: Organized LESS files make customization easy
- Responsive: Works beautifully on all devices
- Performance Optimized: Clean, efficient CSS with no bloat
Design System
The JAVIS design system includes:
- Typography: SF Pro-based system font stack
- Color Palette: Primary blue (#0051ff) with neutral grays
- Spacing: 8pt grid system (4px, 8px, 12px, 16px, 20px, 24px)
- Border Radius: Consistent radii (4px, 8px, 12px, 16px, pill)
- Shadows: Soft, subtle elevation system
Installation & Development
1. Install Dependencies
cd /Users/chiragdugar/Desktop/Javis/javis-community-theme
npm install2. Build the Theme
npm run buildThis compiles less/theme.less into static/lib/theme.css.
3. Development Mode (Watch for Changes)
npm run devThis watches your LESS files and rebuilds automatically on changes.
Deployment to NodeBB Cloud
Option 1: Direct Upload via ACP (Recommended)
Package the theme:
cd /Users/chiragdugar/Desktop/Javis zip -r javis-community-theme.zip javis-community-theme/ -x "*/node_modules/*" "*/.git/*"Upload to NodeBB Cloud:
- Go to your NodeBB Admin Panel (ACP)
- Navigate to: Extend → Install Plugins
- Click "Upload Plugin"
- Select
javis-community-theme.zip - Wait for installation to complete
- Rebuild NodeBB when prompted
Activate the theme:
- Go to: Appearance → Themes
- Select "JAVIS Community Theme"
- Click "Apply" and rebuild
Option 2: Git Repository (For Version Control)
Initialize git (if not already):
cd /Users/chiragdugar/Desktop/Javis/javis-community-theme git init git add . git commit -m "Initial JAVIS theme setup"Push to GitHub:
git remote add origin https://github.com/yourusername/javis-community-theme.git git push -u origin mainInstall from GitHub in NodeBB:
- NodeBB ACP → Extend → Install Plugins
- Enter:
yourusername/javis-community-theme - Click "Install"
File Structure
javis-community-theme/
├── less/
│ ├── theme.less # Main entry point
│ ├── _variables.less # Design tokens
│ ├── _base.less # Global styles & typography
│ ├── _buttons.less # Button system
│ ├── _forms.less # Input & form controls
│ ├── _cards.less # Feed post cards
│ ├── _sidebar.less # Sidebar widgets
│ └── _categories.less # Category list styling
├── static/
│ └── lib/
│ ├── theme.css # Compiled CSS (generated)
│ └── theme.js # Client-side JS
├── templates/ # Custom template overrides (if needed)
├── theme.js # Server-side theme logic
├── plugin.json # NodeBB theme manifest
└── package.json # NPM configurationCustomization Guide
Changing Colors
Edit less/_variables.less:
@jv-primary: #0051ff; // Your primary brand color
@jv-primary-hover: #0044dd; // Hover stateAdjusting Spacing
Modify the spacing scale in less/_variables.less:
@jv-space-2: 4px;
@jv-space-4: 8px;
// ... etcComponent Styling
Each component has its own file:
- Buttons:
less/_buttons.less - Forms:
less/_forms.less - Cards:
less/_cards.less - Sidebar:
less/_sidebar.less - Categories:
less/_categories.less
Adding Custom Components
- Create a new LESS file:
less/_yourcomponent.less - Import it in
less/theme.less:@import "_yourcomponent"; - Rebuild:
npm run build
Maintenance
After Making Changes
- Edit LESS files in the
less/directory - Run
npm run buildto compile - If deployed, re-upload the theme to NodeBB Cloud
- Rebuild NodeBB in the ACP
Updating NodeBB
Since this is a standalone theme, NodeBB updates won't affect your design. However:
- Test the theme after major NodeBB version updates
- Check for any DOM structure changes that might need CSS adjustments
Troubleshooting
Theme Not Applying
- Check that the theme is activated in ACP → Appearance → Themes
- Make sure you rebuilt NodeBB after installation
- Clear browser cache (Cmd+Shift+R)
Styles Not Updating
- Make sure you ran
npm run buildafter editing LESS files - Check that
static/lib/theme.csswas generated - Rebuild NodeBB in the ACP
Missing Dependencies
npm installSupport
For issues or questions:
- Check NodeBB documentation: https://docs.nodebb.org
- NodeBB Community: https://community.nodebb.org
License
MIT License - feel free to customize for your needs!
Built with ❤️ for JAVIS Community
