Skip to content

A nicer look at GitHub profiles built with Next.js and the GitHub API

Notifications You must be signed in to change notification settings

IllusionOfControl/octoprofile

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OctoProfile

A nicer look at your personal GitHub Profile! With charts!

demo

Built with:

Getting Started

To get started, clone the repository and install the dependencies:

git clone https://github.com/IllusionOfControl/octoprofile.git
cd project
npm install

Building and Exporting

To build the static site, run the following command:

GITHUB_PERSONAL_TOKEN=<your-token-here> npm run build

This will generate a static version of the site in the out directory.

To export the site, run the following command:

GITHUB_PERSONAL_TOKEN=<your-token-here> npm run export

This will generate a static version of the site in the out directory that can be deployed to a static hosting service.

Deploying

You can deploy the static site to any static hosting service. One popular option is Vercel.

To deploy to Vercel, create an account and link your GitHub repository. Vercel will automatically detect that this is a Next.js project and deploy it using the appropriate settings. You can set the GITHUB_TOKEN environment variable in the Vercel dashboard.

About

A nicer look at GitHub profiles built with Next.js and the GitHub API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%