-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 175e933
Showing
16 changed files
with
1,010 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Project dependencies | ||
.cache | ||
node_modules | ||
yarn-error.log | ||
|
||
# Build directory | ||
/public | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"semi": false, | ||
"singleQuote": true, | ||
"trailingComma": "es5" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2015 gatsbyjs | ||
|
||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
<p align="center"> | ||
<a href="https://next.gatsbyjs.org"> | ||
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" /> | ||
</a> | ||
</p> | ||
<h1 align="center"> | ||
Gatsby's default starter | ||
</h1> | ||
|
||
Kick off your project with this default boilerplate. This barebones starter ships with the main Gatsby configuration files you might need. | ||
|
||
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://next.gatsbyjs.org/docs/gatsby-starters/)._ | ||
|
||
## 🚀 Quick start | ||
|
||
1. **Install the Gatsby CLI.** | ||
|
||
The Gatsby CLI helps you create new sites using Gatsby starters (like this one!) | ||
|
||
```sh | ||
# install the Gatsby CLI globally | ||
npm install -g gatsby-cli | ||
``` | ||
|
||
2. **Create a Gatsby site.** | ||
|
||
Use the Gatsby CLI to create a new site, specifying the default starter. | ||
|
||
```sh | ||
# create a new Gatsby site using the default starter | ||
gatsby new my-default-starter | ||
``` | ||
|
||
3. **Start developing.** | ||
|
||
Navigate into your new site’s directory and start it up. | ||
|
||
```sh | ||
cd my-default-starter/ | ||
gatsby develop | ||
``` | ||
|
||
4. **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://next.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).* | ||
Open the the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time! | ||
## 🧐 What's inside? | ||
|
||
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 | ||
├── gatsby-ssr.js | ||
├── LICENSE | ||
├── package-lock.json | ||
├── package.json | ||
├── README.md | ||
└── yarn.lock | ||
1. **`/node_modules`**: The directory where 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), like 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 a tool called [Prettier](https://prettier.io/), which 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://next.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://next.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://next.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. | ||
8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://next.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. | ||
9. **`LICENSE`**: Gatsby is licensed under the MIT license. | ||
10. **`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). | ||
11. **`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. | ||
12. **`README.md`**: A text file containing useful reference information about your project. | ||
13. **`yarn.lock`**: [Yarn](https://yarnpkg.com/) is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as `package-lock.json`, just for a different package management system. | ||
## 🎓 Learning Gatsby | ||
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://next.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://next.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://next.gatsbyjs.org/docs/).** In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar. | ||
## 💫 Deploy | ||
[](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
/** | ||
* Implement Gatsby's Browser APIs in this file. | ||
* | ||
* See: https://www.gatsbyjs.org/docs/browser-apis/ | ||
*/ | ||
|
||
// You can delete this file if you're not using it |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
module.exports = { | ||
siteMetadata: { | ||
title: 'Gatsby Default Starter', | ||
}, | ||
plugins: [ | ||
'gatsby-plugin-react-helmet', | ||
{ | ||
resolve: "gatsby-source-prismic", | ||
options: { | ||
// The name of your prismic.io repository. This is required. | ||
// Example: 'gatsby-source-prismic-test-site' if your prismic.io address | ||
// is 'gatsby-source-prismic-test-site.prismic.io'. | ||
repositoryName: "dewynters", | ||
|
||
// An API access token to your prismic.io repository. This is required. | ||
// You can generate an access token in the "API & Security" section of | ||
// your repository settings. Setting a "Callback URL" is not necessary. | ||
// The token will be listed under "Permanent access tokens". | ||
accessToken: "MC5XN1Noa0JRQUFDb0FiLWYw.A--_vRLvv70n77-977-9D--_vQPvv70bCRZE77-977-977-9U0_vv73vv71vNO-_ve-_ve-_vRHvv73vv73vv73vv70", | ||
|
||
// Set a link resolver function used to process links in your content. | ||
// Fields with rich text formatting or links to internal content use this | ||
// function to generate the correct link URL. | ||
// The document node, field key (i.e. API ID), and field value are | ||
// provided to the function, as seen below. This allows you to use | ||
// different link resolver logic for each field if necessary. | ||
// See: https://prismic.io/docs/javascript/query-the-api/link-resolving | ||
linkResolver: ({ node, key, value }) => doc => { | ||
// Your link resolver | ||
}, | ||
|
||
// Set a list of links to fetch and be made available in your link | ||
// resolver function. | ||
// See: https://prismic.io/docs/javascript/query-the-api/fetch-linked-document-fields | ||
fetchLinks: [ | ||
// Your list of links | ||
], | ||
|
||
// Set an HTML serializer function used to process formatted content. | ||
// Fields with rich text formatting use this function to generate the | ||
// correct HTML. | ||
// The document node, field key (i.e. API ID), and field value are | ||
// provided to the function, as seen below. This allows you to use | ||
// different HTML serializer logic for each field if necessary. | ||
// See: https://prismic.io/docs/nodejs/beyond-the-api/html-serializer | ||
htmlSerializer: ({ node, key, value }) => ( | ||
(type, element, content, children) => { | ||
// Your HTML serializer | ||
} | ||
), | ||
} | ||
}, | ||
{ | ||
resolve: `gatsby-plugin-manifest`, | ||
options: { | ||
name: 'gatsby-starter-default', | ||
short_name: 'starter', | ||
start_url: '/', | ||
background_color: '#663399', | ||
theme_color: '#663399', | ||
display: 'minimal-ui', | ||
icon: 'src/images/gatsby-icon.png', // This path is relative to the root of the site. | ||
}, | ||
}, | ||
'gatsby-plugin-offline', | ||
], | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
/** | ||
* Implement Gatsby's Node APIs in this file. | ||
* | ||
* See: https://www.gatsbyjs.org/docs/node-apis/ | ||
*/ | ||
|
||
// You can delete this file if you're not using it |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
/** | ||
* Implement Gatsby's SSR (Server Side Rendering) APIs in this file. | ||
* | ||
* See: https://www.gatsbyjs.org/docs/ssr-apis/ | ||
*/ | ||
|
||
// You can delete this file if you're not using it |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
{ | ||
"name": "gatsby-starter-default", | ||
"description": "Gatsby default starter", | ||
"version": "1.0.0", | ||
"author": "Kyle Mathews <[email protected]>", | ||
"dependencies": { | ||
"gatsby": "^2.0.0", | ||
"gatsby-plugin-manifest": "^2.0.2", | ||
"gatsby-plugin-offline": "^2.0.5", | ||
"gatsby-plugin-react-helmet": "^3.0.0", | ||
"gatsby-source-prismic": "^1.2.0", | ||
"react": "^16.5.1", | ||
"react-dom": "^16.5.1", | ||
"react-helmet": "^5.2.0" | ||
}, | ||
"keywords": [ | ||
"gatsby" | ||
], | ||
"license": "MIT", | ||
"scripts": { | ||
"build": "gatsby build", | ||
"develop": "gatsby develop", | ||
"format": "prettier --write '**/*.js'", | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"devDependencies": { | ||
"prettier": "^1.14.2" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/gatsbyjs/gatsby-starter-default" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import React from 'react' | ||
import { Link } from 'gatsby' | ||
|
||
const Header = ({ siteTitle }) => ( | ||
<div | ||
style={{ | ||
background: 'rebeccapurple', | ||
marginBottom: '1.45rem', | ||
}} | ||
> | ||
<div | ||
style={{ | ||
margin: '0 auto', | ||
maxWidth: 960, | ||
padding: '1.45rem 1.0875rem', | ||
}} | ||
> | ||
<h1 style={{ margin: 0 }}> | ||
<Link | ||
to="/" | ||
style={{ | ||
color: 'white', | ||
textDecoration: 'none', | ||
}} | ||
> | ||
{siteTitle} | ||
</Link> | ||
</h1> | ||
</div> | ||
</div> | ||
) | ||
|
||
export default Header |
Oops, something went wrong.