Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/v4iv/gatsby-starter-business

Gatsby Business Website Starter
https://github.com/v4iv/gatsby-starter-business

bulma-css elasticlunr gatsby gatsby-starter gatsbyjs netlify-cms pagination seo-friendly

Last synced: 5 days ago
JSON representation

Gatsby Business Website Starter

Awesome Lists containing this project

README

        

# gatsby-starter-business
A [Gatsby v2](https://www.gatsbyjs.org/) and [Netlify CMS](https://www.netlifycms.org) powered generic business website.

It follows the [JAMstack architecture](https://jamstack.org) by using Git as a single source of truth, and [Netlify](https://www.netlify.com) for continuous deployment, and CDN distribution.

## Demo
[Gatsby Starter Business](https://gatsby-starter-business.netlify.com)

## Features
* Complete Business Website Suite - Home Page, About Page, Pricing Page, Contact Page and Blog
* Netlify CMS for Content Management
* SEO Friendly (Sitemap, Schemas, Meta Tags, GTM etc)
* Bulma and Sass Support for styling
* Progressive Web App & Offline Support
* Tags and RSS Feed for Blog
* Disqus and Share Support
* Elastic-Lunr Search (NEW)
* Pagination (NEW)
* Contact Form (Netlify Forms)
* Easy Configuration using `config.js` file

## Prerequisite
* Node
* Gatsby CLI (globally installed)

## Getting Started
Create your own project with Gatsby CLI:
```shell
gatsby new yourbusinessname https://github.com/v4iv/gatsby-starter-business.git
```

## Available Scripts

### Develop
Start a hot-reloading development environment accessible at `localhost:8000`
```shell
yarn start
```

### Build
Get an optimized production build for your site generating static HTML and per-route JavaScript code bundles.
```shell
yarn build
```

### Serve
gatsby serve — Gatsby starts a local HTML server for testing your built site.
```shell
yarn serve
```

### Lint
Lint the code according to eslintrc file, for consistency.
```shell
yarn lint
```

### Clean
Remove the .cache and public for a scratch compile.
```shell
yarn clean
```

## Configuration
To personalize and configure this Starter open `config.js` file and replace the default values.

```javascript
module.exports = {
siteTitle: 'Gatsby Starter Business', // Site title.
siteTitleAlt: 'Business', // Alternative site title for SEO.
siteLogo: '/icons/icon-512x512.png', // Logo used for SEO and manifest.
siteUrl: 'https://gatsby-starter-business.netlify.com', // Domain of your website without pathPrefix.
// Do not use trailing slash!
pathPrefix: '/', // Prefixes all links. For cases when deployed to example.github.io/gatsby-starter-business/.
siteDescription: 'Leverage Gatsby Business Starter for your Business.', // Website description used for RSS feeds/meta description tag.
siteRss: '/rss.xml',
siteFBAppID: '', // FB Application ID for using app insights
googleTagManagerID: '', // GTM tracking ID.
disqusShortname: 'gatsby-business-starter', // Disqus shortname.
userName: 'Vaibhav Sharma',
userTwitter: 'vaibhaved',
userLocation: 'Delhi NCR, India',
userDescription: '',
copyright: 'Copyright © Gatsby Starter Business 2018. All Rights Reserved.', // Copyright string for the footer of the website and RSS feed.
themeColor: '#00d1b2', // Used for setting manifest and progress theme colors.
backgroundColor: '#ffffff', // Used for setting manifest background color.
}

```

## Deployment
Clicking the button will ask for authentication via Github, which will create a repo in your github account with this starter. Then, it will build and deploy the site to Netlify.

Deploy to Netlify

You can read up on how to set up Identity(Authentication for CMS User) here [How To Set Up Netlify CMS](https://www.netlifycms.org/docs/add-to-your-site/)