Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vagr9k/gatsby-advanced-starter

A high performance skeleton starter for GatsbyJS with an advanced feature set.
https://github.com/vagr9k/gatsby-advanced-starter

disqus gatsby gatsby-image gatsby-starter gatsby-theme gatsbyjs markdown netlify-cms offline-support opengraph-tags pwa react rss schema-org seo sitemap social-features static-site-generator styled-components web-app-manifest

Last synced: 2 days ago
JSON representation

A high performance skeleton starter for GatsbyJS with an advanced feature set.

Host: GitHub
URL: https://github.com/vagr9k/gatsby-advanced-starter
Owner: Vagr9K
License: mit
Created: 2017-07-18T20:18:32.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-12-01T05:05:33.000Z (about 1 year ago)
Last Synced: 2024-10-29T15:17:48.848Z (about 2 months ago)
Topics: disqus, gatsby, gatsby-image, gatsby-starter, gatsby-theme, gatsbyjs, markdown, netlify-cms, offline-support, opengraph-tags, pwa, react, rss, schema-org, seo, sitemap, social-features, static-site-generator, styled-components, web-app-manifest
Language: TypeScript
Homepage: https://amaranth-demo.netlify.app/
Size: 53 MB
Stars: 1,564
Watchers: 16
Forks: 404
Open Issues: 30
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Gatsby Advanced Starter

A starter skeleton with advanced features for [Gatsby](https://github.com/gatsbyjs/gatsby/).

This starter aims to provide a minimal base for building advanced GatsbyJS powered websites by using the latest technologies to simplify your process.

It doesn't define any UI limitations in any way and only gives you the basic components for SEO/Links/Infinite Scrolling while creating a comfortable development environment to get started.

Starter supports both [TypeScript](https://www.typescriptlang.org/) and JavaScript, comes with [Jest](https://jestjs.io/) and [Cypress](https://www.cypress.io/) configurations and allows you to write Unit/Integration/E2E tests out of the box.

You are free to use any UI framework/styling options or you can use the [`gatsby-theme-amaranth`](https://www.npmjs.com/package/gatsby-theme-amaranth) as a starting point, which provides a stylish blog design styled with [Styled Components](https://styled-components.com/)

## Demos

[With `gatsby-theme-advanced`](https://advanced-demo.netlify.app/)

[With `gatsby-theme-amaranth`](https://amaranth-demo.netlify.app/).

## Features

- Gatsby v4 support
- First class [TypeScript](https://www.typescriptlang.org/) support (for query data and components exposed by the theme)
- Styled Components used for styling
- Posts in MDX
- Code syntax highlighting
- Embed videos
- Embed iframes
- Infinite Scrolling
- React Query for client side API calls
- Tags
- Separate page for posts under each tag
- Categories
- Separate page for posts under each category
- Social features
- Twitter tweet button
- Facebook share/share count
- Reddit share/share count
- LinkedIn share button
- Author section
- Related posts computation and display based on category/tag match ranking
- [Disqus](https://disqus.com/) support
- [gatsby-plugin-image](https://www.gatsbyjs.com/plugins/gatsby-plugin-image/) for optimized image generation
- Inline SVG imports
- High configurability
- Separate components for everything:
- Gatsby Link utilities
- SEO
- Disqus
- PWA features
- Offline support
- Web App Manifest support
- Loading progress for slow networks
- SEO
- [Google gtag.js](https://developers.google.com/gtagjs/) support
- Sitemap generation
- General description tags
- [Google Structured Data](https://developers.google.com/search/docs/advanced/structured-data/intro-structured-data)
- [OpenGraph Tags (Facebook/Google+/Pinterest)](https://ogp.me/)
- [Twitter Tags (Twitter Cards)](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup)
- RSS feeds
- Development tools
- Yarn 3
- [Jest](https://jestjs.io/) for unit/integration testing
- [Cypress](https://www.cypress.io/) for E2E testing
- CI via GitHub Actions
- CD via GitHub Actions
- [ESLint](https://eslint.org/) for linting
- [Prettier](https://prettier.io/) for code formatting
- [React Hooks Linting](https://www.npmjs.com/package/eslint-plugin-react-hooks)
- Remark-Lint for linting Markdown
- write-good for linting English prose
- gh-pages for deploying to GitHub pages
- [Netlify](https://www.netlify.com/) deploy configuration

## Getting Started

Install this starter by running the following commands from your CLI:

```sh
gatsby new YourProjectName https://github.com/Vagr9K/gatsby-advanced-starter
cd YourProjectName
yarn develop # or gatsby develop
```

Note that the [Gatsby CLI](https://www.npmjs.com/package/gatsby-cli) needs to be installed and updated for the `gatsby` command to work.

Alternatively you can fork the project, make your changes and merge new upstream features when needed:

- [Fork this repository on GitHub](https://github.com/Vagr9K/gatsby-advanced-starter/fork)
- Run the following commands:

```sh
git clone https://github.com/${YourUsername}/${YourForkName} YourForkName # Clone your fork
cd YourForkName
yarn install # or npm install
yarn develop # or gatsby develop
```

## Receiving upstream updates

You have multiple options when it comes to receiving upstream updates:

- Pull and merge upstream changes into your repo
- Change the versions of `gatsby-theme-advanced` and `gatsby-theme-amaranth` from local to remote.
- Install a different theme, such as the [`gatsby-theme-material`](https://www.npmjs.com/package/gatsby-theme-material).

First option allows you to make your own changes to the themes without having to fork and publish them. This is the default approach when you clone/fork the starter repository.

Second option simplifies your CI/CD setup and allows you to receive updates by simply bumping the package version. This also applies if you decide to use a different theme with the starter.

To switch to the remote versions, open `package.json` and edit the dependency section:

```js
"gatsby-theme-amaranth": "*",
// or
"gatsby-theme-advanced": "*",
```

into

```js
"gatsby-theme-amaranth": "3.2", // Or the version you want
// or
"gatsby-theme-advanced": "3.2", // Or the version you want
```

If you want to install a different theme outside of the repo, such as the [`gatsby-theme-material`](https://www.npmjs.com/package/gatsby-theme-material), run:

```sh
yarn add gatsby-theme-material # Or any other Gatsby theme
```

Then configure the theme in `gatsby-config.js`:

```js
module.exports = {
plugins: [
{
resolve: `gatsby-theme-material`, // Or any other theme that you have installed
options: {
basePath: `/blog`, // Consult the documentation of the respective theme to figure out the applicable settings
},
},
],
};
```

## Configuration

### Select a starting point

To configure the theme edit your `gatsby-config.js`:

```js
module.exports = {
plugins: [
{
resolve: `gatsby-theme-advanced`,
options: {
basePath: `/blog`,
},
},
],
};
```

Here you can switch between `gatsby-theme-advanced` and `gatsby-theme-amaranth` or any other Gatsby theme that you intend to use with the starter.

For configuring the themes, consult their respective documentation pages:

- [Advanced](themes/advanced/README.md)
- [Amaranth](themes/amaranth/README.md)

### NetlifyCMS

First of all, make sure to edit `static/admin/config.yml` and add your [GitHub/GitLab/NetlifyId credentials](https://www.netlifycms.org/docs/authentication-backends/):

```yml
backend:
name: github # Refer to https://www.netlifycms.org/docs/authentication-backends/ for auth backend list and instructions
branch: master # Branch to update
repo: vagr9k/gatsby-material-starter # Repo for pushing new commits. Make sure to replace with your repo!
```

You can visit `/admin/` after and will be greeted by a login dialog (depending on the auth provider you ave chosen above).

If want to customize Netlify CMS, e.g. registering custom widgets or styling the preview pane, you can do so by editing `src/netlifycms/index.js`:

```js
import CMS from "netlify-cms-app";

CMS.init({
config: {
backend: {
name: "git-gateway",
},
},
});
```

For NetlifyCMS specific issues visit the [official documentation](https://www.netlifycms.org/docs/intro/).

### Contributing

If you have any issues, questions or suggestions related to the starter then feel free to bring them up!

If you'd like to contribute to the repository and need some pointers, take a look at the [Contribution Guide](./.github/CONTRIBUTING.md).

# Author

Ruben Harutyunyan ([@Vagr9K](https://twitter.com/Vagr9K))