README.md

OKai Contributors Site Generator

OK, creators of the okai framework. This repo generates static sites showing GitHub contributor activity.

Website: | Discord | Twitter/X | DAO

Setup

1. Install dependencies:

npm install

2. Put your contributor data JSON files in the data directory

3. Build and generate the site:

npm run build
npm run generate

4. Open profiles/index.html to view the result

Directory Structure

• data/ - Place contributor JSON files here
• scripts/ - Source code
• dist/ - Built files
• profiles/ - Generated static site

Scripts

• npm run build - Bundle the site generator
• npm run generate - Generate the static site