FORK this repo first! Once forked to your own account...
On terminal:
For SSH
git clone git@github.com:swfl-coders/website.git
For HTTP
git clone https://github.com/swfl-coders/website.git
-
Install Gatsby globally (if not installed yet).
On terminal:
npm i -g gatsby-cli
-
Start developing.
Navigate into project and start up.
cd website npm install gatsby develop
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.NOTE: If you are receiving build errors after running
npm install
, your environment may have to be setup to build popular native Node.js modules that Gatsby uses. To learn more about setting up your build environment for your system, read the documentation under the Additional Guides section on Gatsby. -
Contribute to this project
To contribute, please read our contributing guidelines
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
├── package-lock.json
├── package.json
└── README.md
-
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/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”. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc
: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
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. -
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). -
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. -
gatsby-ssr.js
: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering. -
LICENSE
: Gatsby is licensed under the MIT license. -
package-lock.json
(Seepackage.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). -
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. -
README.md
: A text file containing useful reference information about your project.
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.
Here is an example of using queries in a non-page component, you have to use the <StaticQuery />
component
import Img from "gatsby-image"
import { graphql, StaticQuery } from "gatsby"
<StaticQuery
query={graphql`
query {
file(relativePath: { eq: "swfrtp-logo.png" }) {
childImageSharp {
fluid(maxWidth: 50) {
...GatsbyImageSharpFluid
}
}
}
}
`}
render={data => (
<Img fluid={data.file.childImageSharp.fluid} />
)}
/>