Lumen

A minimal, lightweight and mobile-first starter for creating blogs uses Gatsby.

Table of contents

• Features
• Web Performance Tests
• Quick Start
• Folder Structure
• Related
• Contributors
• Backers
• Sponsors
• Credits
• License

Features

• Create and modify content via Crafter CMS
• Server Content to ReactJS based Blog application via GraphQL
• Lost Grid.
• Modern font stack.
• Beautiful typography inspired by matejlatin/Gutenberg.
• Syntax highlighting in code blocks using PrismJS.
• Mobile-First approach in development.
• Archive organized by tags and categories.
• Pagination support.
• Google Analytics.
• Disqus Comments.
• Flow static type checking.

Web Performance Tests

• Lighthouse Report - WebPageTest
• Visual Comparison - WebPageTest

Quick Start

Create Site

Create a site in Crafter CMS based on this blueprint via remote repository or the Crafter CMS Marketplace.

Once the project is created, start your Gatsby Server (See section: Start Developing) and your site preview will become enabled.

To start your server, in the sources location Example:

On First Run:
    npm install
    crafterSiteId=YOUR_SITE_ID gatsby develop

On Subsequent Runs:
    crafterSiteId=YOUR_SITE_ID gatsby develop

Start Developing

Navigate into your new site’s directory and start it up.

cd blog
gatsby develop

Open the source code and start editing!

Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

Open the blog directory in your code editor of choice and edit src/templates/index-template.js. Save your changes and the browser will update in real time!

Deploy to Github Pages

To deploy to github pages, simply do the following:

• Ensure that your package.json file correctly reflects where this repo lives
• Change the pathPrefix in your config.js
• Run the standard deploy command

npm run deploy

Access Locally

$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
$ cd [REPO_NAME]
$ yarn
$ npm run develop

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

$ npm run build
$ gatsby serve

Folder Structure

└── content
    ├── pages
    └── posts
└── static
    ├── admin
    └── media
└── src
    ├── assets
    │   └── scss
    │       ├── base
    │       └── mixins
    ├── cms
    │   └── preview-templates
    ├── components
    │   ├── Feed
    │   ├── Icon
    │   ├── Layout
    │   ├── Page
    │   ├── Pagination
    │   ├── Post
    │   │   ├── Author
    │   │   ├── Comments
    │   │   ├── Content
    │   │   ├── Meta
    │   │   └── Tags
    │   └── Sidebar
    │       ├── Author
    │       ├── Contacts
    │       ├── Copyright
    │       └── Menu
    ├── constants
    ├── templates
    └── utils

Related

Statinamic port by Khoa Nguyen

Contributors

Thanks goes to these wonderful people!

vzhou842	abisz	mariolopjr	ihororlovskyi	timbroder	vinnymac

yodahuang	axelclark	BigTony666	ybbarng	marktani	concreted

chmac	charandas	marcelabomfim	zollillo	codejet	reed-jones

stigrune	swapnilmishra	vvasiloud	vstoms	wichopy	yairmark

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

Credits

Nature graphic by Anna Bearne from Noun Project is licensed under CC BY 3.0.

License

The MIT License (MIT)

Copyright (c) 2016-2019 Alexander Shelepenok

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.