Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fitzwilliammuseum/the-human-touch

Exhibition site in Gatsby
https://github.com/fitzwilliammuseum/the-human-touch

cambridge-university exhibition gatsby static-site

Last synced: 2 days ago
JSON representation

Exhibition site in Gatsby

Awesome Lists containing this project

README 

        
The Human Touch - A Fitzwilliam Museum exhibition site



## 🧐 What's inside?



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



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.com/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.com/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.com/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://www.gatsbyjs.com/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.



9.  **`LICENSE`**: This  is licensed under the GPLV3 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.



## Develop



To run locally:



```bash

git clone https://github.com/FitzwilliamMuseum/the-human-touch

cd the-human-touch

gatsby develop

```



## 💫 Deploy



This site runs off a github pages branch. To deploy follow these steps locally on your machine (assuming that you have git installed):



### Local deploy to Github Pages

```bash

npm run build

npm run deploy

```



### Repository deploy to Netlify



[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/fitzwilliammuseum/the-human-touch)