DirtyF / brevifolia-next-frank

A simple blog starter using Next.js and Forestry as a Git-backed CMS.

Brevifolia

About

Brevifolia is minimalist blog starter to get you going using Forestry with Next.js.

👀 Preview

This blog is statically generated by Next.js, a rendered combination of React components and Markdown / JSON files. It is preconfigured to work with Forestry🌲 as a way to manage your content. Forestry is a Git-backed CMS, meaning it makes content changes by editing Markdown or YAML/JSON/TOML files, uploading media to the correct directory and committing these updates to your repo directly.

The styles were coded & designed using styled-jsx (which is inherently supported by Next.js). The font used is Work Sans.

Quick Setup

Import to Forestry

The easiest way to get started is to import the site in Forestry, this will clone the repository and provide a user interface to edit and preview your site.

Run locally

To run the site locally, clone the repository, navigate to your project's folder and run yarn.

# install dependencies
yarn

# run site locally
yarn develop

Navigate to http://localhost:3000 to see your site.

Project Structure

• Site-level configuration is stored in data/config.json.
• Edit styles within each component or page file within the <style jsx> tags.
• Global styles live in the Meta component.
• src/posts/contains all your markdown blog posts.
• src/static/ is where you images live and will get uploaded.
• src/pages is where you page components live.
• The blog pages are dynamically generated with a slug parameter. See the template in src/pages/blog/[slug].js.
• The pages & template are comprised of components from src/components.
• The routes are generated in next.config.js with exportPathMap

Using Forestry as your CMS

The .forestry directory contains all the settings information and frontmatter configuration to allow Forestry to setup the sidebar structure and editing capacity for this blog. After importing this blog into forestry, you can access and edit all of the content via the sidebar.

You can add new blog posts, data files, or entire pages and sections to fit your needs. You can also customize how media is handled, by configurating gitLFS, Cloudinary, S3, or Netlify Large Media.

You can set up a remote admin for content editors to log in directly to yoururl.com/admin to make content updates.

Instant Previews

The instant preview method spins up the a development server for a long-lived preview that can quickly respond to content updates. When using instant previews, your preview command should be the develop command. The development server spawned by this command should be available over port 8080, and bind to 0.0.0.0. The forestry:preview command in this project's package.json will launch a dev server compatible with Forestry's instant previews.

Deployment

Import your repository on Netlify to automatically build this site. A Netlify config file is provided with default build settings.

[build]
  publish = "src/out"
  command = "yarn deploy"

You can also deploy this site to Vercel if you prefer.

When Forestry makes commits to your repo, Netlify will auto-trigger a rebuild / deploy when new commits are made.