Opal is a powerful Item Management Application built in Ruby on Rails. It allows you to list any kind of item, from houses to video games to hotdog vendors. When you install Opal, you tell it the name of the items you're going to be listing(example: houses), and that's it! After that, you can create any number of items and show them off using different Plugins.
![]() ![]() People are using Opal to monitor electricity usage, list entertainment events, list ruby on rails applications, review video games, build a Blender 3d model library, and more! |
Opal User Guide
Having trouble figuring how to do something in Opal? Want to learn about everything Opal can do? Take a look at the user manual!Help & Faqs
The best way to install Opal and figure out how it works is to open the INSTALL file included with the download. It will tell you everything about how to get it up and running... and how to use it! Also, check out the README file, it has some good info in it as well. If you need any help, check out our forum, or ask us!
A Plugin is a form of information that describes your items. Plugins take the form of Images(in a gallery), Reviews(allows users to rate an item), Files(files for an item, like if you are listing software and wanted to provide an installer), and so on.
Here's the Plugins that come with Opal.
Images
- Pictures you can upload from your computer or a url. You can also apply special effects to these images(b & w, sepia, rotation).
Descriptions
- BIG blocks of text that tell you more about an item. These are great for large, descriptive details about an item, or for writing an article or a big review of something.
Comments
- Little notes/messages left by other users about an item.
Reviews
- Other users can score your particular item, so we know how good it is. Everyone's a critic.
Files
- Basically an attachment to an item. It can be any file uploaded from your computer.
Tags
- Small text labels that can be used to as an alternative method of organization. If we were listing houses, some might be: blue, mansions, or modern.
Features
- Shared features or attributes that each item would have. If we were listing houses, these would be: Rooms: 4, Price: $100,000. Stuff like that.
Links
- Hyperlinks to other websites or webpages for an item.
Just make sure you're logged in, and go to the item page you just created(you can get there by browsing the category you added the item to, or by going to My Account, then "My [items]"). When you're logged in as the user that created the item or an admin, you'll see a pencil icon(the icon for editing) next to the items you can edit. Click on them to edit.
Opal automatically hides things that aren't be used. So if you are looking at an item you've created, you'll see a bunch of different Plugins you can add(like images, files, comments, etc.). If there aren't any of a particular Plugin added for your item, the section won't be visible to people that aren't logged in or other users. This keeps the page clean and eliminates sections that say stuff like "No Images added yet", which clutter up the page.
Yes! There are two banner files that are empty when you install Opal, but when you paste any code into them, they will show at either the top or bottom of your Opal site. The files are located in app/views/browse/_banner_top.rhtml(shows at the top of the page) or app/views/browse/_banner_bottom.rhtml(shows at the bottom of the page).
Development
Do you like Opal, but you think it's missing a little something? We're open to suggestions! In our Dev center, you can monitor the progress of the next release of Opal, recommend new features, report bugs, and you can even download any release of Opal if you want to work on your own version.Themes
|
|
White SquareThe Default Theme for Opal. A clean white and blue interface.
Download: Included with Opal. |
|
|
VaultA cool, dark theme with orange highlights.
Download: Included with Opal. |
|
|
Grey TodayA neutral grey theme with orange highlights.
Download: 0.1.8 |
|
|
ElectronMonAn electrifying theme in blue and yellow.
Download: 0.1.8 |
Make Your Own Theme
You can easily make your own theme for Opal! Just download the example theme template, change the name of the folder, and upload it into the Opal directory public/themes(Opal automatically recognizes all theme folders in public/themes), and get started!Plugins
Plugins allow you to add new functionality to your items. Opal comes packed with the popular ones(Reviews, Images, Comments, Tags, Files, etc.), but here are some more that will come in handy!
More Plugins coming soon!


















