Install Awesome Studio Platform Plugin
The quickest way to install Awesome Studio plugin is by going to our 'Install' page, and specifying URL where you want to install. In case that option does not work, you can download the plugin directly from WordPress.org, and follow the detailed instructions for manually installing Awesome Studio.
Install Monomyth Theme (optional)
To get most out of Awesome Studio, you will need to download and install Monomyth theme, you can find the detailed instruction for installation in "Installing monomyth theme" tutorial. Along with Monomyth zip file, you will also need to Import aw2_core posts xml, which is required for Monomyth to function normally. While, installing Monomyth is optional for usage of Awesome Studio platform, it is strongly recommended. It makes Awesome Studio even more powerful and takes your development to next level for creating websites and application in WordPress. Most importantly it does not blot you website by loading unnecessary scripts and styles.
Enable Dev Mode
Once Awesome Studio platform plugin is installed, you need to go to your edit profile page and give your self developer access by selecting the checkbox. Only administrators with developer access will be able to create, edit or delete modules and app within awesome studio, even editing or creating new core module for Monomyth theme requires developer access.
Quick Overview of Platform
Awesome Studio platform is made up of core shortcodes library, custom shortcodes, modules and triggers. Modules & Triggers are also grouped together to form Apps.
Awesome TriggersAwesome triggers are special modules that are executed during various WordPress action and filter hooks. If you need to do some activity at init like register custom post types, load SPA libraries etc, this is where you write them. Currently on small number of useful WordPress hooks are supported.
Awesome ShortcodesThis is another special type of module that allows you to wrap commonly used workflows within a project as shortcode. This allows us to use them as easy as we use other core shortcodes of awesome studio platform. These shortcodes can only be used within an awesome modules. For more details see aw2.shortcode.
Awesome AppsAwesome Apps takes over a slug to create custom workflows easily. The slug you create is taken over by awesome studio to give you custom flow. It has it's own set of modules and triggers. By using Awesome Apps you can package custom workflows neatly, and at the same time make future maintenance super simple.
Awesome CoreAwesome Core modules are used by Monomyth theme to create global headers, footers and custom post layouts. These core modules can not be used by any other modules. but they can call and use global modules within them. It allows you to create custom post type and archive layouts quickly using existing modules.
Awesome CatalogueAwesome catalogue is list of ready to use modules, triggers, shortcodes and apps that you can install within your website in just one click and use. As our catalogue grows it will reduce development time further, as you can just install the module, include within your page and be done.
Creating Your First Awesome Module
Awesome Modules are the basic building blocks of a page within Awesome Studio platform. Within a website we first identify all the modules we need then we create/install them for use. We then use these ready modules to quickly assemble new layouts for our pages. Here is how you can create and use a module.
- create a global module :
- Click on 'Awesome Studio' in the left panel and then click on 'Global Modules'.
- Click on 'Add Awesome Module'
- Let's Give our module a title, 'hello-awesome', we generally write the title in small letters and without spaces to ensure that the slug and title for the module are same making it easier to remember the slug of a module. We use the slug to refer these modules.
- Click the publish button, you can also use 'crtl+s' to save the modules
- calling it within a page
- Now you have a published module that can be used within page or another module. let's see how to use awesome module.
- Click on pages -> add new page on the left panel.
- Give it a title "Test Awesome Module"
- In the content area type following
- By using aw2.module you call a module, and by using aw2.this within aw2.module you can set the parameters of the module.
- Save the page, and view this page.
- Now let's call this module again within the same page
- Save the page and check again. This is how we create and use a awesome module.
- calling it within another module
Creating Your First Awesome App
- Register your App (better install blank app from catalouge)
- Create App specific module
- Call them inside the App specific pages.
- Visit the App URL to see it working