Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lesliecdubs/pamela-rae-schuller

Personal site for Pamela Rae Schuller, comedian and advocate
https://github.com/lesliecdubs/pamela-rae-schuller

gatsby personal-website

Last synced: 9 days ago
JSON representation

Personal site for Pamela Rae Schuller, comedian and advocate

Awesome Lists containing this project

README

        


Pamela Rae Schuller

[![Netlify Status](https://api.netlify.com/api/v1/badges/b13366f3-9553-43e6-b8ec-3be20b41f9cc/deploy-status)](https://app.netlify.com/sites/pamela-comedy/deploys)

Pamela Rae Schuller does inclusion differently. Through comedy, storytelling, and laughter, Pamela will transform your worldview and leave your group with concrete goals and a new mindset to become more inclusive.

This repo contains Pam's personal website. The site:
- runs on [Gatsby](https://www.gatsbyjs.org), the static site generator for React
- is powered by [Contentful](http://www.contentful.com), with content maintained and updated by Pamela and team
- uses [Sass](https://sass-lang.com/) for super-powered styles
- deploys to [Netlify](http://www.netlify.com)

## πŸš€ Quick start

1. **First-time setup.**

Clone this repo and install project dependencies.

```sh
git clone [email protected]:lesliecdubs/pamela-rae-schuller.git
cd pamela-rae-schuller/
yarn install
```

1. **Start developing.**

When you're ready to develop, run this command to get Gatsby going.

```sh
yarn develop
```

1. **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://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).*

Open 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`**: 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.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://www.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://www.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://www.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.