https://github.com/ooloth/gatsby-starter
Custom starter for new Gatsby projects.
https://github.com/ooloth/gatsby-starter
gatsby react-spring xstate
Last synced: 5 months ago
JSON representation
Custom starter for new Gatsby projects.
- Host: GitHub
- URL: https://github.com/ooloth/gatsby-starter
- Owner: ooloth
- License: other
- Created: 2019-01-14T20:15:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-07T16:22:28.000Z (almost 4 years ago)
- Last Synced: 2025-01-18T11:23:03.066Z (about 1 year ago)
- Topics: gatsby, react-spring, xstate
- Language: JavaScript
- Homepage: https://gatsbystarter.netlify.app
- Size: 76.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WEBSITE_TITLE website
[](https://app.netlify.com/sites/website/deploys)
These are the source files for [WEBSITE_TITLE's website](https://www.website.com).
## Overview
- WEBSITE_TITLE's site is built in React using [Gatsby](https://www.gatsbyjs.org).
## How to add the site to your local dev environment
To modify this site, make sure you have node, npm, git and Gatsby installed globally (if not, see [this tutorial](https://www.gatsbyjs.org/tutorial/part-zero/) to get up and running).
Then, make sure you have SSH set up on your local machine to connect to your GitHub account. If you need instructions for setting this up, see [Connecting to GitHub with SSH](https://help.github.com/en/articles/connecting-to-github-with-ssh).
Finally, clone this repo to your local machine, install the project dependencies, and run the 'dev' script:
```
// navigate to parent folder, then run:
git clone git@github.com:ORG_NAME/REPO_NAME.git
npm install
npm run dev
```
## How to update the site's content
In general, update the source files on your computer, then push your changes to GitHub:
```
git add .
git commit -m "Description of update..."
git push
```
When you `git push` your changes, Netlify will automatically deploy the new
version of the site. (You can set up email notifications in the site's settings on Netlify to alert you when the build succeeds or fails.)
To prevent issues on the live site, always confirm the build works locally by running `npm run build && gatsby serve` before pushing your changes to the repo.
### How to update text
- Update the text in the relevant `YAML` file in `src/data/`.
- If the text needs to include HTML (or other special formatting), add the HTML tags to the YAML string and then make sure the markup outputs the string using `dangerouslySetInnerHTML={{ __html: variable }}`.
### How to update images
- Add the new images to `src/images/`.
- Add the relevant image details (e.g. file path, alt text, object-position) to the appropriate `YAML` file in `src/data/`.
### TODO: Add any exceptional updating instructions here...
## Confused?
* Learn more about [Gatsby](https://www.gatsbyjs.org/tutorial/) and
[here](https://www.gatsbyjs.org/docs/).
* Learn more about [Netlify](https://www.netlify.com/docs/).
* Learn more about [GitHub](https://help.github.com/en#dotcom).
* Learn more about [git](https://git-scm.com/doc).