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

https://github.com/jsulpis/github-insights

Insights into a GitHub profile.
https://github.com/jsulpis/github-insights

nextjs webapp

Last synced: about 2 months ago
JSON representation

Insights into a GitHub profile.

Awesome Lists containing this project

README

          

GitHub Insights


Insights into a GitHub profile




CI


Quality Gate Status


Coverage


PRs Welcome


Screenshot of the application

## Installation

Clone the repository and install the dependencies:

```shell
git clone https://github.com/jsulpis/github-insights.git && cd github-insights && npm i
```

## Usage

### Setup

You will need a GitHub OAuth token to query the GraphQL endpoint. See the [documentation](https://developer.github.com/v4/guides/forming-calls/#authenticating-with-graphql) for more details. Then put your token in the GITHUB_API_TOKEN variable in a .env file.

### Development

Serve with hot reload at localhost:3000

```
npm run dev
```

### Build

Build for production: next.js automatically generates a mix of static HTML pages when possible, and lambda functions for server-side rendered pages. This is supported out-of-the-box by Vercel.

```
npm run build
```

Serve the production build with SSR:

```
npm start
```

See package.json for other scripts.

## License

Released under the [MIT](https://github.com/jsulpis/github-insights/blob/master/LICENSE) license.