Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/Collabsalot/gatsby-starter

A Gatsby starter
https://github.com/Collabsalot/gatsby-starter

gatsby gatsby-starter gatsbyjs typescript

Last synced: 16 days ago
JSON representation

A Gatsby starter

Host: GitHub
URL: https://github.com/Collabsalot/gatsby-starter
Owner: Collabsalot
License: mit
Created: 2019-10-27T01:50:57.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-04T23:31:16.000Z (about 2 years ago)
Last Synced: 2023-03-03T03:05:45.528Z (almost 2 years ago)
Topics: gatsby, gatsby-starter, gatsbyjs, typescript
Language: TypeScript
Homepage:
Size: 2.48 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 30
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
[![All contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors)

[![Issues and pull requests labeled "Status: Help wanted"](https://img.shields.io/github/labels/Collabsalot/gatsby-starter/Status%3A%20Help%20wanted?label=label)](https://github.com/Collabsalot/gatsby-starter/labels/Status%3A%20Help%20wanted)

[![Netlify build status](https://img.shields.io/netlify/d3b00a2e-01bf-4619-bd37-f37f48e0a6a6)](https://app.netlify.com/sites/gatsby-starter-collabsalot/deploys)

[![License](https://img.shields.io/github/license/Collabsalot/gatsby-starter)](./LICENSE)

[![GitHub repo size](https://img.shields.io/github/repo-size/Collabsalot/gatsby-starter)](https://shields.io/category/size)

[![GitHub code size](https://img.shields.io/github/languages/code-size/Collabsalot/gatsby-starter)](https://shields.io/category/size)

# gatsby-starter

- [Features](#features)

- [Getting started](#getting-started)

    - [Install](#install)

- [Contributors](#contributors)

- [License](#license)

## Features

- TypeScript

- Auto-generated types from GraphQL

- Linting with ESLint

- Formatting with Prettier

- Pre-commit hooks for linting, formatting, and type-checking

- PWA (Progressive Web App)

- Lighthouse CLI

## Getting started

### Install

> Please do not fork this repository to use it as a starter, or else every time you push code, GitHub will think you want to make a pull request to this repository.

You have a few choices for installation:

1. If you'll be hosting your website's code on GitHub, just click on the "Use this template" button above, then:

   ```bash

   git clone https://github.com/[user-name]/[project-name].git

   cd [project-name]

   yarn

   ```

1. If you'll be hosting it elsewhere, or you're a traditionalist:

   ```bash

   gatsby new [project-name] https://github.com/Collabsalot/gatsby-starter.git

   cd [project-name]

   # Replace the following with whatever URL format your host uses, if not GitHub

   git remote add origin https://github.com/[user-name]/[project-name].git

   ```

1. If you prefer to keep the starter's git history intact, so that you can use git to pull in changes made to the starter:

   ```bash

   git clone https://github.com/Collabsalot/gatsby-starter.git [project-name]

   cd project-name

   git remote rename origin upstream

   git remote add origin https://[host-name]/[user-name]/[project-name].git

   ```

## Contributors

Contributions of any kind welcome! Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Martin Rosenberg}
💻 📖 🤔 🚇 🚧 📆

  

## License

This starter is © 2019 Martin Rosenberg. It is available under an [MIT](https://spdx.org/licenses/MIT.html) license, [included](./LICENSE). Any non-software content is available under a [CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html) license. Use it all in good health, and let me know if you'd like me to showcase anything you create with it!