TarrySingh / gatsby-starter-foundation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Netlify Status   Follow @stackrole

Foundation

A starter to launch your blazing fast personal website and a blog, Built with Gatsby and Netlify CMS.

Deploy to Netlify

Need help launching your website? My DM's are open on twitter

Gatsby Starter Foundation Screenshot

πŸ‘Œ Features

  • A Blog and Personal website with Netlify CMS.
  • Responsive Web Design
  • Dark / Light Mode
  • Customize content of Homepage, About and Contact page.
  • Add / Modify / Delete blog posts.
  • Edit website settings, Add Google Analytics and make it your own all with in the CMS.
  • SEO Optimized
  • Social media icons
  • OpenGraph structured data
  • Twitter Cards meta
  • Beautiful XML Sitemaps
  • Netlify Contact Form, Works right out of the box after deployment.
  • Invite collaborators into Netlify CMS, without giving access to your Github account via Git Gateway
  • Gatsby Incremental Builds with Netlify.

Gatsby Starter Foundation Screenshot

πŸš€ Quick Deploy

Just click on the Deploy to Netlify button.

Deploy to Netlify

This would fork gatsby-starter-foundation to your Github account and start building your website on Netlify. Once the deployment is done. Your website will be live and website address would look like site-name.netlify.app

Further Instructions

βš™ Access to Netlify CMS

  • Goto app.netlify.com > select your website from the list
  • Goto identity and Click Enable Identiy
  • Click on Invite Users and invite yourself. You will recieve an email and you need to accept the invitation to set the password.
  • Now headover to Settings > Identity > Services and Enable Git Gateway
  • You can also manage who can register and log in to your CMS. Goto Settings > Identity > Registration >Registration Preferences. I would prefer to keep it to Invite Only, if i am the only one using it.
  • Now, goto to site-name.netlify.app/admin/, and login with your credentials.

πŸ“ Editing content and Adding posts

Once you are in your Netlify CMS, you can navigate to Posts and Pages. Here you will find a list of existing pages and posts.

You can select any existing post or page to start editing or add a New Post. Have fun :)

βš™ Customing Site details

You can find all the website settings such website Site title, Website URL, Google anlaytics etc,.. in your Netlify CMS Admin > Settings > General

🌐 Adding Custom domain to netlify website

We have written a short article on Custom domain with Netlify website

πŸ–₯ Install Locally

Use the Gatsby CLI to create a new site, specifying the gatsby-starter-foundation starter.

gatsby new gatsby-starter-foundation https://github.com/stackrole/gatsby-starter-foundation

You need Node and Gatsby-CLI installed, check out Gatsby Setup Instructions

Start developing

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

cd my-hello-world-starter/
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 gatsby-starter-foundation directory in your code editor of choice and edit. Save your changes and the browser will update in real time!

You can use Netlify CMS in you local just run npx netlify-cms-proxy-server and start run gatsby develop

πŸ“ Folder Structure

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
β”œβ”€β”€ node_modules
β”œβ”€β”€ src
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .prettierrc
β”œβ”€β”€ gatsby-browser.js
β”œβ”€β”€ gatsby-config.js
β”œβ”€β”€ gatsby-node.js
β”œβ”€β”€ LICENSE
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md
  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for β€œsource code”.

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  8. LICENSE: Gatsby is licensed under the MIT license.

  9. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  10. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  11. README.md: A text file containing useful reference information about your project.

πŸŽ“ Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

πŸ™ Thank you

We really appreciate you taking time to build your website with our gatsby-starter-foundation.

I would love to get your feedback and contributions.

Feel free to ping @stackrole for help regarding your JAMstack website, our DM's are open. And do not forget to share you website with me 😊

Check out Stackrole.com - A Jamstack marketplace

About

License:MIT License


Languages

Language:JavaScript 69.8%Language:SCSS 30.2%