The SDOH & Place Project

A repository for the landing page and the community toolkit of the SDOH & Place Project.

Blog: Decap CMS Implementation

We have integrated a Decap CMS blog into this site, which is managed through Netlify. Features of this integration include:

• A draft > ready > publish workflow handled via commits and branches
• Content pages written in MDX: Markdown with optional React component integration
• A browser-based user interface accessible at /admin

To create/edit/delete blog posts:

• Log in with your GitHub credentials at https://sdohplace.org/admin and create/edit/delete content there

Or

• Switch to the publish branch and make direct edits to the .mdx files in content/news

Tips for Writing Blog Posts

• Each post should have at least one tag.
• Don't use < or > in the text of a post. If you need those characters, use < (lt = "less than") and > (gt = "greater than").
  • The reason for this is that markdown can support inclusion of HTML elements, which look like <element-name>. If <> are found outside of a valid HTML element, they will cause an error.

Branch Configuration

The production site is built from the publish branch and visible at https://sdohplace.org.

A staging site is built from the main branch and is visible at https://main--cheerful-treacle-913a24.netlify.app/.

The staging site should only be used to preview code changes, not to create/edit/delete blog posts.

To contribute code to this repo:

1. Create a feature branch from main
2. Commit code to it and create a PR against main
3. After the PR is merged, changes will be reflected on the staging site
4. To deploy, create another PR from main against the publish branch

The publish branch should never be merged back into the main branch!

We've chosen this setup to keep code development history on the main branch, and isolate all of the blog-authored commit activity to the publish branch.

Local Installation

git clone https://github.com/healthyregions/SDOHPlace && cd SDOHPlace
yarn install
yarn dev

View in browser at http://localhost:3000.

To build and view the entire site locally, use

yarn build
yarn start

Local Decap Blog

To access the blog backend locally for testing, it is best to use the test backend that Decap provides.

In public/admin/config.yml change name: git-gateway to name:test-repo.

Now, go to http://localhost:3000/admin/index.html.

This backend does not have access to your file system, so you can create content and update collections configurations without affecting any local files. All content will be lost when you refresh the page.