/commerseum-display

Commerseum Display - Simple, open-source digital signage

Primary LanguageJavaScriptMIT LicenseMIT

Commerseum Display v2

Currently WIP. Based on Gatsby + Decap CMS Starter. For the older still-working version, please see the v1 branch.

Note: This starter uses Gatsby v4.

The web app harnesses the JAMstack architecture by using Git as a single source of truth, and Netlify for continuous deployment, and CDN distribution.

Features

  • A simple digital signage application based on Decap CMS
  • Create playlists and scenes from decap CMS admin page
  • Uses Bulma for styling, but size is reduced by gatsy-plugin-purgecss
  • Blazing fast loading times thanks to pre-rendered HTML and automatic chunk loading of JS files
  • Uses gatsby-plugin-image with Decap CMS preview support
  • Netlify deploy configuration
  • ..and more

Prerequisites

  • Volta to install Node etc
  • Node.js version 18+ (Volta will recognize in package.json)

Access Locally

Pulldown a local copy of the Github repository, either this one or your own fork:

$ git clone https://github.com/nerds-with-keyboards/commerseum-display.git
$ cd commerseum-display
$ npm i
$ npm start

To test the CMS locally, you'll need to run a production build of the site:

$ npm run serve

Setting up the CMS

Follow the Decap CMS Quick Start Guide to set up authentication, and hosting for production.

If you want use Decap CMS locally, run the site in one terminal with npm run start and in another Terminal you can use npx netlify-cms-proxy-server which proxy requests so you'll be automatically logged in as a user on http:localhost:3000/admin.

Debugging

Windows users, who aren't using WSL, might encounter node-gyp errors when trying to npm install. To resolve, make sure that you have both Python 2.7 and the Visual C++ build environment installed.

npm config set python python2.7
npm install --global --production windows-build-tools

Full details here.

MacOS and WSL users who might also encounter some errors, check node-gyp for more info. We recommend using the latest stable node version.

Purgecss

This plugin uses gatsby-plugin-purgecss and bulma. The bulma builds are usually ~170K but reduced 90% by purgecss.

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.