Exhibition site in Gatsby
A quick look at the top-level files and directories you’ll see in a Gatsby project.
.├── node_modules├── src| ├── components| ├── images| ├── markdown-pages| ├── pages| └── templates├── static├── .gitignore├── .prettierrc├── gatsby-browser.js├── gatsby-config.js├── gatsby-node.js├── gatsby-ssr.js├── LICENSE├── 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: This is licensed under the GPLV3 license
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).
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.
To run locally:
git clone https://github.com/FitzwilliamMuseum/the-human-touchcd the-human-touchgatsby develop
This site runs off a github pages branch. To deploy follow these steps locally on your machine (assuming that you have git installed):
npm run buildnpm run deploy
