# gatsby-starter-github-portfolio

> Gatsby starter to show your github portfolio

Latest version **0.1.0** (published 2020-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-starter-github-portfolio
pnpm add gatsby-starter-github-portfolio
yarn add gatsby-starter-github-portfolio
bun add gatsby-starter-github-portfolio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-05-28 |
| First published | 2017-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | ldds |

## Links

- npm: https://www.npmjs.com/package/gatsby-starter-github-portfolio
- npm.io page: https://npm.io/package/gatsby-starter-github-portfolio

## Dependencies (7)

- [gatsby](https://npm.io/package/gatsby.md) ^2.22.12
- [muicss](https://npm.io/package/muicss.md) ^0.9.25
- [preact](https://npm.io/package/preact.md) ^10.4.4
- [gatsby-link](https://npm.io/package/gatsby-link.md) ^2.2.9
- [gatsby-plugin-preact](https://npm.io/package/gatsby-plugin-preact.md) ^4.0.0
- [preact-render-to-string](https://npm.io/package/preact-render-to-string.md) ^5.1.8
- [gatsby-source-github-api](https://npm.io/package/gatsby-source-github-api.md) ^0.1.1

## Recent versions

- 0.1.0 (latest) — 2020-05-28
- 0.0.1 — 2017-09-12

## README

### gatsby-starter-github-portfolio

This is a starter site that attempts to follow the following flow:

1. During development:

- fetch data from github
- filter and sort the data you got from github

2. At build time:

- static results get you a static page

3. When accessing the site:

- no API calls to Github's API

## Install

`npm install gatsby-starter-github-portfolio`

## Configuration

- get a [personal access token from github](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
- create a new file `.env` and save your token:

```
TOKEN=very-long-unreadable-string-goes-here
```

- modify `gatsby-config.js`. Replace `ldd` (my user name) with yours. For example:

```
  q: "author:someUser is:merged state:closed type:pr sort:comments",
  author: "someUser"

```

## Run

- `yarn develop` or `npm develop` for development

- `yarn build` or `npm build` to create a build that you can deploy to your favourite host

## Tips and tricks

You probably want to look at [gatsby-source-github-api](https://github.com/ldd/gatsby-source-github) for how to make valid queries.

Ideally, you should only modify:

- `gatsby-config.js` to change the `graphQL` query from the github API
- `main.js` to change the `query` on the data
- `dataParser.js` to filter and sort the data you got

### FAQ

#### There was an error in your GraphQL query

- make sure you have a token and that you saved it in a file named `.env`
- if you want to make a RAW github v4 Query, do it in `gatsby-config.js`
  - My plugin, `gatsby-source-github-api` takes an optional field, `graphQLQuery`, that let's you define it

---
_Source: https://npm.io/package/gatsby-starter-github-portfolio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._