Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wkencel/WillKencelGatsbySite

My static site at willkencelhome.io made from Gatsby and hosted on AWS -- blazing fast responsiveness!
https://github.com/wkencel/WillKencelGatsbySite

gatsby gatsby-starter

Last synced: about 1 month ago
JSON representation

My static site at willkencelhome.io made from Gatsby and hosted on AWS -- blazing fast responsiveness!

Awesome Lists containing this project

README 

        
# Will Kencel's website built with Gatsby



A starter to launch your blazing fast personal website and a blog, Built with [Gatsby][gatsby] and hosted on AWS (s3/cloudfront/route 53).  Feel free to use as a model for your own.



Need help launching your website? Feel free to reach me at [email protected]



## 👌 Features

- A Blog and Personal website with Gatsby CMS.

- Responsive Web Design

- Dark / Light Mode

- Customize content of Homepage, Blog, 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

## 🚀 Quick Deploy



1. run `yarn install`

2. run `gatsby build` to create the production build

3. run `npm run start` which will in turn run the `gatsby development` command

4. see and edit your site using localhost:8000

5. when you're ready, copy the public folder to an s3 bucket and host your site with cloudfront cdn, s3 and route 53 (if you need a domain name)

### Further Instructions

- [Editing content and Adding posts](#editing-content-and-adding-posts)

- [Customing Site details](#customing-site-details)

- [Install Locally](#install-locally)

- [Folder Structure](#folder-structure)

- [Learning Gatsby](#learning-gatsby)

- [Thank you from Stackrole](#thank-you)



## 🖥 Install Locally

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

```bash

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

```

> You need Node and Gatsby-CLI installed, check out Gatsby [Setup Instructions](https://www.gatsbyjs.org/tutorial/part-zero/)



### Start developing

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

```shell

cd WillKencelGatsbySite/

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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._



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!



## 📁 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](https://prettier.io/). 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](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).



7.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/). Here are some places to start:



- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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](https://www.gatsbyjs.org/docs/).** 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 email me at [email protected] for help regarding this template or the code



[gatsby]: https://gatsbyjs.org