Installing the Blog Module

Last edit: 

Contributors: 

This guide will help you install the platformOS Blog Module.

This guide is part of a series that walks you through the process of building a blog on platformOS. You can find previous and next parts of the series in the Requirements and Next steps sections.

Requirements

So that you can follow the steps in this tutorial, you should have set up a platformOS Instance and your codebase, and you should have NPM and the Marketplace Kit installed on your computer. You should also understand the concept of layouts, modules, and migrations.

Steps

Installing the Blog Module is a three-step process:

  1. Install Dashboard Module
  2. Register Blog Administrator
  3. Setup blog

Step 1: Install Blog Module

Log in to the Partner Portal and go to your Instance detail view.
At the bottom of the page in the Available modules section search for "platformOS Blog" and click Install on the right. You will receive an email notification when the installation process is complete.

Step 2: Create Blog Administrator

A simple administration panel is included in the Blog module, where you can configure your blog and create its content. By default, this part is restricted for registered users with Administrator role.

In order to create your first Admin:

  1. Visit your instance page.
  2. Go to the signup page by appending /sign-up to your instance address in your browser's address bar.
  3. Create your first user by sending the form.
  4. You will be redirected to the /log-in page, where you need to provide the same user login and password.
  5. Blog comes with a handy migration which grants Administrator role to all existing users:
marketplace-kit migrations run staging modules/dashboard/20190102222130

Result:

[Migration Run] Done. modules/dashboard/20190102222130_promote_users_to_admins executed.
  1. Go to Dashboard page by appending /dashboard to your instance address in your browser's address bar.

Step 3: Setup Blog

On your Dashboard page click on "Blog" in the left side navigation. You will see your Blog navigation, choose "Blog settings" and fill in all the required details. Save your changes.

You can now see your blog at [your-Instance-URL]/blog.

If you want to display your blog content on your home page, define it as follows:

---
slug: /
layout_name: modules/dashboard_blog/blog
---

{% include 'modules/dashboard_blog/blog/index' %}

The Blog module doesn't define header and footer of your website as these elements are dynamic and specific to the given instance.
You can define your header and footer HTML in marketplace_builder/views/partials/layouts/header.liquid and marketplace_builder/views/partials/layouts/footer.liquid

Next steps

Congratulations! You have installed the Blog Module. Now you can write your first blog post:

Questions?

We are always happy to help with any questions you may have. Check out our Help page, or contact us.