/github-insights

Insights into a GitHub profile.

Primary LanguageTypeScriptMIT LicenseMIT

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:

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 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 license.