Getting Started with Commerseum and Netlify

Commerseum can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify.

This guide provides detailed instructions on how to get started with Commerseum, including downloading the source code from the GitHub repository, hosting your site on Netlify, and additional resources for troubleshooting and further information.

Please feel free to reach out to us at [email protected] where our team will help you set up Commerseum for you incase you area having trouble to follow along this guide.

To quickly try out Commerseum, you can follow these steps to set it up using Netlify:

Sign up for a Netlify account:

To begin, you need to sign up for a Netlify account. This process is simple and requires providing your email address and creating a password. Follow these steps:

  1. Visit the Netlify website at www.netlify.com.

  2. Click the “Sign Up” and fill your email address and a secure password. It is always recommended to use a strong password and save it to the cloud.

Create a new site:

After successfully creating your Netlify account, you can now create a new site. Follow these steps:

  1. Log in to your Netlify account..

  2. Click the “Deploy to Netlify” button below:
    Button Image for Deploying

  3. Authenticate with github and allow Netlify to deploy it after giving it a name.

  4. You can monitor the progress of the build on the Netlify dashboard, which will display any error messages or warnings if necessary.

Configure your settings:

Once you have deployed the site, you can configure the settings for your Commerseum site. Follow these steps:

  1. The dashboard provides various options and settings for your deployed site.

  2. To authorize users to log in to Commerseum, you need to configure Netlify's Identity service. To do this, look for the Identity section in the Netlify dashboard under “Integration” on the sidebar.

  3. Enable the Netlify Identity Service and now you will be able to invite users to perform more configurations.

Configure your domain:

To make your Commerseum site accessible through your own domain, you'll need to configure your domain settings. Follow these steps:

  1. In your Netlify dashboard, navigate to the "Domain settings" section.

  2. Now go to DNS settings to point your domain to your Netlify site's URL. Use a domain of your choice.

Your site will now be up and running. Moreover, you can customize your site and add your own content or playlist of contents to display on the screens of your choice.

Downloading the Source Code:

To begin with Commerseum locally, you'll need to download the source code from our GitHub repository. Follow these steps:

  1. Visit our GitHub repository at https://github.com/nerds-with-keyboards/commerseum-display.

  2. Locate the "Download" button on the repository page and click on it.

  3. Choose the desired format for the download, for example ‘ZIP’ and save it to your local storage.

  4. Now, extract the source code files from the downloaded file.

  5. Follow the instructions on the ReadMe page on the github link for running Commerseum locally.

How to use Commerseum on your device ?

After you've depployed using netlify, you can now use display your content.

If you are displaying the content on your TV, follow these steps:

  1. Go to Web Browser of your TV

  2. If your TV doesn't have a web browser , you can use a device that lets you use a brwoser like a chromestick or xbox.

  3. On the browser, go to your version of commerseum.netlify.app (your domain)

  4. Select the scene or the playlist you want to display in full screen mode.

How to deploy my content on Commerseum?

  1. Go to your admin page provided by netlify using "…/admin".

  2. There are 2 options that you can choose from:

Scene :

This can contain videos, URL,texts, images, images with texts and more.

Playlist:

This can consist of mulitple Scenes that is displayed in a sequence.

Now, choose one of scene or playlist you want to display by clicking on it.

If you need any assistance, reach out to us at [email protected]