https://github.com/tomdewildt/gatsby-site-template

Simple starter template for building Gatsby sites with Markdown and Styled Components
https://github.com/tomdewildt/gatsby-site-template

actions gatsby javascript markdown react styled-components

Last synced: about 7 hours ago
JSON representation

Simple starter template for building Gatsby sites with Markdown and Styled Components

• Host: GitHub
• URL: https://github.com/tomdewildt/gatsby-site-template
• Owner: tomdewildt
• License: mit
• Created: 2020-10-23T13:04:55.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T23:42:13.000Z (20 days ago)
• Last Synced: 2024-10-19T13:47:13.433Z (19 days ago)
• Topics: actions, gatsby, javascript, markdown, react, styled-components
• Language: JavaScript
• Homepage:
• Size: 20.8 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gatsby Site Template

[![Build](https://img.shields.io/github/actions/workflow/status/tomdewildt/gatsby-site-template/ci.yml?branch=master)](https://github.com/tomdewildt/gatsby-site-template/actions/workflows/ci.yml)

[![Coverage](https://img.shields.io/codecov/c/gh/tomdewildt/gatsby-site-template)](https://codecov.io/gh/tomdewildt/gatsby-site-template)

[![License](https://img.shields.io/github/license/tomdewildt/gatsby-site-template)](https://github.com/tomdewildt/gatsby-site-template/blob/master/LICENSE)

Simple starter template for building [Gatsby](https://www.gatsbyjs.com/) sites with [Markdown](https://daringfireball.net/projects/markdown/) and [Styled Components](https://styled-components.com/).

# How To Run

Prerequisites:

* node version ```18.12.1``` or later

* npm version ```8.19.2``` or later

### Development

1. Run ```npm install``` to initialize the environment.

2. Run ```npm start``` to start the dev server.

### Production

1. Run ```npm install``` to initialize the environment.

2. Run ```npm run build``` to build the site.

3. Run ```npm run serve``` to serve the production build.

Run ```npm run clean``` to clean the build files & cache.

# References

[Gatsby Docs](https://www.gatsbyjs.org/docs/)

[Gatsby File Structure](https://medium.com/@thenyaobin/exploring-the-project-structure-of-gatsby-3c71a06208b0)

[React Docs](https://reactjs.org/docs/)

[Styled Components Docs](https://styled-components.com/docs)

[ARIA Roles, Attributes & Techniques](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques)

[React Testing Library Cheatsheet](https://testing-library.com/docs/react-testing-library/cheatsheet)

[React Testing Library Queries](https://testing-library.com/docs/dom-testing-library/api-queries)

[React Testing Library Events](https://testing-library.com/docs/dom-testing-library/api-events)