Gatsby's Firebase hosting starter
Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
Have another more specific idea? You may want to check out our vibrant collection of official and community-created starters.
A Firebase project.
Install Firebase CLI - see documentation
A Firebase deploy token (FIREBASE_DEPLOY_TOKEN). See Documentation
$ firebase login:ci
Install Google Cloud SDK - see documentation
Your project's code in a remote GIT repository (Github, Bitbucket or Cloud Source repository)
🚀 Quick start
Create a Gatsby site.
Use the Gatsby CLI to create a new site, specifying the default starter.
# create a new Gatsby site using the default starter gatsby new my-firebase-hosting-starter https://github.com/gatsbyjs/gatsby-firebase-hosting-starter
Navigate into your new site’s directory and start it up.
cd my-firebase-hosting-starter/ gatsby develop
Open the source code and start editing!
Your site is now running at
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.
my-firebase-hosting-starterdirectory in your code editor of choice and edit
src/pages/index.js. Save your changes and the browser will update in real time!
Associate your project with a Firebase Project
If you have not done so already, first login to firebase from the command line:
$ firebase login
Check that you have access to your firebase project:
# list available firebase projects $ firebase list
Associate this project directory with a Firebase project. When prompted choose the alias of your choice (e.g. default).
$ firebase use --add
Setup Cloud Build
- Login to the Google Cloud Console
- Click the project dropdown menu. In the dialog that opens select the 'ALL' tab. Select the Firebase project you wish to use.
- Navigate to the Cloud Build section
- Click 'Enable Cloud Build API'. (If you are prompted to setup billing, instructions on how to do this can be found here or navigate directly to the Billing section)
- Login to Google Cloud on the command line
$ gcloud auth login
- Check that you have access to your project
$ gcloud projects list
- Associate this project directory with your gcloud project.
$ gcloud config set project PROJECT_ID
- Submit a build to Cloud Build which uses the cloudbuild.yaml build config and the source in the
firebasedirectory. The build installs the firebase tool in the environment. Then, the tool is containerized and pushed to your Container Registry.
gcloud builds submit --config=./firebase/cloudbuild.yaml ./firebase/
- Run your first deploy from the command line to check everything is working correctly
gcloud builds submit --config=cloudbuild.deploy.yaml . --substitutions=_FIREBASE_DEPLOY_TOKEN="[FIREBASE_DEPLOY_TOKEN]"
🧐 What's inside?
A quick look at the top-level files and directories you'll see in a Gatsby project.
. ├── config ├── firebase ├── node_modules ├── src ├── tests ├── .firebaserc ├── .gitignore ├── cloudbuild.deploy.yaml ├── firebase.json ├── gatsby-browser.js ├── gatsby-config.js ├── gatsby-node.js ├── gatsby-ssr.js ├── LICENSE ├── package-lock.json ├── package.json └── README.md
/config: This directory contains configuration files for ESlint and lint-staged. The ESlint configuration uses the recommended settings from the Gatsby docs. The lint-staged configuration will lint all files staged files on a precommit hook.
/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.
srcis a convention for “source code”.
/tests: This directory contains the setup for Jest as documented in the Gatsby Unit testing documentation
.firebaserc: Stores yout firebase project aliases
.gitignore: This file tells git which files it should not track / not maintain a version history for.
cloudbuild.deploy.yaml: This file contains the build configuration for Cloud Build to run the following scripts as build steps:
# Install all project dependencies npm install
# Valididate source code complies with linting rules and run's Jest Unit tests. npm run validate
# build gatsby source npm run build
# Deploy built source to firebase firebase deploy
firebase.json: Your firebase project configuration. See the documentation for more information
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.jsonbelow, 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.
🎓 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.
If you followed the section Setup Cloud Build all you should need to do now is to setup a build trigger to run a deploy using your FIREBASE_DEPLOY_TOKEN listening for changes in your remote git repository.