oh-my-github

Create your Github profile in 5 minute

Demo

Link: Demo

Usage

1. Install

• NodeJS 5.0.0+ (NVM Installation Guide)
• Linux Installation Guide

$ npm install -g oh-my-github@latest

2. Create Github API token

You should create an access token to send 50+ github API requests

• Link: Creating Access Token
• oh-my-github does not require any write permission. It uses read only Github APIs

3. Prepare a viewer

You can publish your oh-my-github.json using Github gh-pages with viewers like the demo

• Create a new repository to be published. The repository name must be oh-my-github (e.g. 1ambda/oh-my-github )
• You can create your own viewers (In this tutorial, we will use the default viewer)

$ git clone [email protected]:oh-my-github/viewer.git oh-my-github
$ cd oh-my-github

$ git remote remove origin
$ git remote add upstream [email protected]:oh-my-github/viewer.git

4. Publish to gh-pages

$ cd oh-my-github

$ omg init [GITHUB_ID] oh-my-github       # (e.g) omg init 1ambda oh-my-github
$ omg generate [GITHUB_TOKEN]             # (e.g) omg generate 394fbad49191aca
$ omg preview
$ omg publish

If you have problems with omg publish, use native git commands instead. For example,

$ cd oh-my-github                         # where `oh-my-github.json` exists

$ git add remote origin [email protected]:[GITHUB_ID]/oh-my-github.git
$ git init
$ git add --all
$ git commit -m "initial commit"
$ git checkout -b gh-pages
$ git push origin HEAD

5. Update

Profile Database (oh-my-github.json)

$ cd oh-my-github                         # where `oh-my-github.json` exists

$ omg generate [GITHUB_TOKEN]             # (e.g) omg generate 394fbad49191aca
$ omg publish                             # publish

Viewer

$ cd oh-my-github                         # where `oh-my-github.json` exists

$ git checkout master
$ git pull upstream master --rebase
$ git checkout gh-pages
$ git rebase master

Command

Type omg -help in your terminal

$ omg -help

  Usage: omg [options] [command]

  Commands:

    init <user> oh-my-github    initialize `oh-my-github.json`
    generate <token>            fill `oh-my-github.json` using github API
    preview                     preview your github profile
    publish                     publish gh-pages using the generated profile

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

  Examples:

    $ omg init 1ambda oh-my-github
    $ omg generate 1b94910adb394014939fal1bfd193bfd762c4191
    $ omg preview
    $ omg publish

Development

1. Install

$ npm install -g typescript@next tsd gulp jasmine
$ npm install
$ tsd install

2. Command

$ GITHUB_TOKEN=[GITHUB_TOKEN] npm run test 
$ npm run build 
$ npm run dist

4. IDEA Setting (Optional)

Use TypeScript and ES6 compiler

• TypeScript compiler path

~/.nvm/versions/node/v5.0.0/lib/node_modules/typescript/lib $ typescriptService.js path

• TypeScript compiler option

--experimentalDecorators -t es6 --emitDecoratorMetadata

• IDEA TypeScript Compiler Error: TypeError: hosts.fileExists

See, https://gist.github.com/1ambda/d04b4406dbb4bed7daa4