package.json

{
  "name": "gh-contributions",
  "version": "3.0.11",
  "description": "A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.",
  "main": "lib/server.js",
  "repository": {
    "type": "git",
    "url": "git://github.com/IonicaBizau/github-contributions.git"
  },
  "keywords": [
    "contributions",
    "github",
    "git"
  ],
  "bin": "./lib/server.js",
  "scripts": {
    "start": "node ./lib/server.js"
  },
  "author": "Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)",
  "contributors": [
    "Ionică Bizău <bizauionica@gmail.com>",
    "Silviu Bogan <silviubogan@gmail.com>",
    "Guilherme Sad <gorgulhoguilherme@gmail.com>",
    "ComFreek <comfreek@outlook.com>",
    "Adrian Moisey <adrian@changeover.za.net>",
    "James Nylen <jnylen@gmail.com>",
    "Sin <dev@zouxin.net>",
    "Aleen42 <aleen42@vip.qq.com>"
  ],
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/IonicaBizau/github-contributions/issues"
  },
  "homepage": "https://github.com/IonicaBizau/github-contributions",
  "devDependencies": {},
  "dependencies": {
    "gry": "^4.0.0",
    "lien": "0.0.11",
    "socket.io": "^2.4.0",
    "ul": "^5.0.0"
  },
  "blah": {
    "h_img": "http://i.imgur.com/w6nVEgj.png",
    "show_installation": false,
    "installation": [
      {
        "h2": "Installation"
      },
      {
        "h3": "Global installation"
      },
      {
        "p": "[Ensure you configured NPM and NodeJS not to require `sudo` when installing packages globally](https://github.com/IonicaBizau/dotfiles#npm-config)."
      },
      {
        "code": {
          "language": "js",
          "content": "$ npm i -g gh-contributions"
        }
      },
      {
        "p": "To start the GitHub contributions server, do:"
      },
      {
        "code": {
          "language": "js",
          "content": "$ gh-contributions"
        }
      },
      {
        "h3": "Notes for installing on Windows"
      },
      {
        "p": "For this application to work well on Windows, Git must be installed with the option to put it in `PATH` enabled, like in this screenshot:"
      },
      {
        "img": {
          "source": "http://i.imgur.com/UOkx35j.png"
        }
      },
      {
        "p": "If Git is not installed with this option selected, *gh-contributions* will not be able to generate the repository."
      },
      {
        "h3": "Local installation"
      },
      {
        "code": {
          "language": "js",
          "content": [
            "$ git clone git@github.com:IonicaBizau/github-contributions.git",
            "$ cd github-contributions",
            "$ npm i",
            "$ npm start"
          ]
        }
      },
      {
        "h2": "Usage"
      },
      {
        "p": [
          "The server runs on the `9000` port. Open `http://localhost:9000/` in your browser.",
          "Check the help information on the app page (`http://localhost:9000`), after you start the app."
        ]
      },
      {
        "h3": "Running Server Inside Docker Container"
      },
      {
        "p": "**You will need to use a version lower than `3.0.0` to run this in Docker. Currently this is not supported anymore.**"
      },
      {
        "p": "Build Docker container locally:"
      },
      {
        "code": {
          "language": "sh",
          "content": "docker build -t github-contributions ."
        }
      },
      {
        "p": "Start Docker container:"
      },
      {
        "code": {
          "language": "sh",
          "content": "docker run --rm -it -p 127.0.0.1:9000:9000 --name=github-contributions-server github-contributions"
        }
      },
      {
        "p": "Open `http://localhost:9000/` in your browser."
      }
    ]
  },
  "files": [
    "bin/",
    "app/",
    "lib/",
    "dist/",
    "src/",
    "scripts/",
    "resources/",
    "menu/",
    "cli.js",
    "index.js",
    "bloggify.js",
    "bloggify.json",
    "bloggify/"
  ]
}