github-contributions/package.json at master · IonicaBizau/github-contributions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{
  "name": "gh-contributions",
  "version": "3.0.12",
  "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",
    "index.d.ts",
    "package-lock.json",
    "bloggify.js",
    "bloggify.json",
    "bloggify/"
  ]
}