├── gantt-example.png
├── package.json
├── .github
└── issue_template.md
├── config
└── config-example.js
├── .gitignore
├── setup.sh
├── README.md
├── fixIssue.js
├── utilities.js
├── index.html
├── index.js
└── LICENSE
/gantt-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/realm/github-gantt/HEAD/gantt-example.png
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "github-gantt",
3 | "version": "0.0.1",
4 | "description": "Gantt chart for Github issues",
5 | "main": "index.js",
6 | "dependencies": {
7 | "body-parser": "^1.17.1",
8 | "dateformat": "^2.0.0",
9 | "dhtmlx-gantt": "^4.1.0",
10 | "express": "^4.15.2",
11 | "octokat": "^0.6.4",
12 | "realm": "^1.2.0"
13 | },
14 | "devDependencies": {},
15 | "scripts": {
16 | "test": "echo \"Error: no test specified\" && exit 1"
17 | },
18 | "author": "Adam Fish",
19 | "license": "GPL-2.0"
20 | }
21 |
--------------------------------------------------------------------------------
/.github/issue_template.md:
--------------------------------------------------------------------------------
1 | ## Summary
2 |
3 |
4 |
5 | ## Other links or relevant information
6 |
7 |
8 |
9 | ## Roadmap Data
10 |
11 | #### 🗓 Start Date:
12 | #### 🗓 Expected Date:
13 | #### 💪 Label:
14 | #### 📈 Progress (0-1):
15 |
--------------------------------------------------------------------------------
/config/config-example.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | // Your Github Access Token
3 | GITHUB_API_TOKEN: "",
4 |
5 | // The name of the Github organization
6 | GITHUB_ORG_NAME: "",
7 | // The repo name in the Github organization
8 | GITHUB_REPO_NAME: "",
9 |
10 | // Configuration for the labels in Github issues to search for
11 | START_DATE_STRING: "#### 🗓 Start Date:",
12 | DUE_DATE_STRING: "#### 🗓 Expected Date:",
13 | LABEL_STRING: "#### 🏷 Label:",
14 | PROGRESS_STRING: "#### 📈 Progress (0-1):",
15 |
16 | // Configuration to use Realm Mobile Platform
17 | RMP_ADMIN_TOKEN: "",
18 | RMP_SYNC_URL: "", // realm://127.0.0.1:9080/github-gantt
19 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files for more about ignoring files.
2 | #
3 | # If you find yourself ignoring temporary files generated by your text editor
4 | # or operating system, you probably want to add a global ignore instead:
5 | # git config --global core.excludesfile '~/.gitignore_global'
6 |
7 | # Ignore Node
8 | node_modules
9 | *.realm
10 | *.realm.lock
11 | *.realm.management
12 | /realm-object-server
13 | /config/config.js
14 | /config/*.realm
15 | /config/*.realm.lock
16 | /config/*.realm.management
17 | /config/realm-object-server
18 | realm-professional.tgz
19 |
20 | # Ignore all logfiles and tempfiles.
21 | /log/*.log
22 | /tmp
23 | *.DS_Store
24 |
--------------------------------------------------------------------------------
/setup.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | echo "Please type in your Github API token: "
4 | read GITHUB_API_TOKEN
5 | if [ -z "${GITHUB_API_TOKEN}" ]; then
6 | echo "You need to provide a token to connect to your GitHub API"
7 | exit 1
8 | fi
9 |
10 | echo "Please type in your Github org name: "
11 | read GITHUB_ORG_NAME
12 | if [ -z "${GITHUB_ORG_NAME}" ]; then
13 | echo "You need to provide an org name"
14 | exit 1
15 | fi
16 |
17 | echo "Please type in your Github repo name: "
18 | read GITHUB_REPO_NAME
19 | if [ -z "${GITHUB_REPO_NAME}" ]; then
20 | echo "You need to provide an repo name"
21 | exit 1
22 | fi
23 | # copying default configuration file without overwritting
24 | cp -n ./config/config-example.js ./config/config.js
25 | # filling in ./config.js with typed values
26 | sed -i.bak "s/\(GITHUB_API_TOKEN: \).*$/\1\"${GITHUB_API_TOKEN//\//\\/}\",/" ./config/config.js
27 | sed -i.bak "s/\(GITHUB_ORG_NAME: \).*$/\1\"${GITHUB_ORG_NAME//\//\\/}\",/" ./config/config.js
28 | sed -i.bak "s/\(GITHUB_REPO_NAME: \).*$/\1\"${GITHUB_REPO_NAME//\//\\/}\",/" ./config/config.js
29 | rm ./config/config.js.bak
30 | # installing node dependencies
31 | npm install
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Github-Gantt
2 | Generate Gantt Charts From Github Issues!
3 |
4 | 
5 |
6 | For organizations, especially open-source teams, that spend their day in Github there is no easy way to visualize the time
7 | table on work outlined in issues. Instead, this requires syncing Github issues with other charting or roadmapping tools,
8 | creating an unnecessary burden to use multiple tools.
9 |
10 | This project seeks to simplify this disconnect and bring Gantt charting together with Github issues. The initial issue comment
11 | is parsed for specific search strings to identify the start/end dates, which label to use for bar coloring, and progress. The data is aggregated in a Realm accessed by a Node.js Express server.
12 |
13 | ## Setup
14 | First you will need to configure the server, run:
15 | ```
16 | // Mac
17 | sh ./setup.sh
18 |
19 | // Linux
20 | bash ./setup.sh
21 | ```
22 | This will ask for your Github API token, organization name, and repo name. It will then generate a config file at
23 | ```
24 | /config/config.js
25 | ```
26 | Additional configuration options are available to customize the strings used to search on in the Github issues:
27 | ```
28 | // Your Github Access Token
29 | GITHUB_API_TOKEN: ""
30 |
31 | // The name of the Github organization
32 | GITHUB_ORG_NAME: ""
33 | // The repo name in the Github organization
34 | GITHUB_REPO_NAME: ""
35 |
36 | // Configuration for the labels in Github issues to search for
37 | START_DATE_STRING: "#### 🗓 Start Date:"
38 | DUE_DATE_STRING: "#### 🗓 Expected Date:"
39 | LABEL_STRING: "#### 🏷 Label:"
40 | PROGRESS_STRING: "#### 📈 Progress (0-1):"
41 | ```
42 | ## Start the server
43 | ```
44 | node index.js
45 |
46 | // Specify a port
47 | PORT=80 node index.js
48 | ```
49 |
50 | ### Additional Work
51 | - [x] Support editing in the chart itself, passing back date changes to the Github issue
52 | - [ ] Support listing of dependencies to display in the chart
53 | - [ ] UI improvements to show who the task is assigned to
54 |
--------------------------------------------------------------------------------
/fixIssue.js:
--------------------------------------------------------------------------------
1 | const GitHub = require('octokat');
2 | const utilities = require('./utilities');
3 | const config = require('./config/config');
4 |
5 | const OLD_STRING = "#### 💪 Team:";
6 | const NEW_STRING = "#### 🏷 Label:";
7 |
8 | const gh = new GitHub({
9 | token: config.GITHUB_API_TOKEN
10 | });
11 |
12 | let repo = gh.repos(config.GITHUB_ORG_NAME, config.GITHUB_REPO_NAME);
13 |
14 | // Change Github Issues To New Config
15 | function fixIssues(issues, oldVal, newVal, completion, issueMap) {
16 | if (!utilities.isObject(issueMap)) {
17 | issueMap = {};
18 | }
19 |
20 | for (index in issues.items) {
21 | let issue = issues.items[index];
22 |
23 | // find old value
24 | if (issue.body != null) {
25 | var lines = issue.body.split('\r\n');
26 | var didUpdate = false;
27 | for (var j = 0; j < lines.length; j++) {
28 | if (!lines[j].indexOf(oldVal)) {
29 | lines[j] = lines[j].replace(oldVal, newVal);
30 | didUpdate = true;
31 | }
32 | }
33 |
34 | if (didUpdate) {
35 | let newBody = lines.join('\r\n');
36 | issueMap[issue.number] = newBody;
37 | }
38 | }
39 | }
40 |
41 | if (utilities.isString(issues.nextPageUrl)) {
42 | issues.nextPage.fetch()
43 | .then((moreIssues) => {
44 | fixIssues(moreIssues, oldVal, newVal, completion, issueMap);
45 | });
46 | }
47 | else {
48 | let keys = Object.keys(issueMap);
49 | let total = keys.length;
50 | var completedIssues = [];
51 | for (index in keys) {
52 | let key = keys[index];
53 | let value = issueMap[key];
54 | console.log("Updating Issue: "+key);
55 | repo.issues(key).update({
56 | body: value,
57 | }).then((issue) => {
58 | completedIssues.push(key);
59 | if (completedIssues.length == total) {
60 | completion();
61 | }
62 | });
63 | }
64 | }
65 | }
66 |
67 | console.log('--> Changing: "'+OLD_STRING+'" to "'+NEW_STRING+'"');
68 |
69 | repo.issues.fetch({state: "all", per_page: 100})
70 | .then((issues) => {
71 | fixIssues(issues, OLD_STRING, NEW_STRING, () => {
72 | console.log('--> Did Change: "'+OLD_STRING+'" to "'+NEW_STRING+'"');
73 | process.exit();
74 | });
75 | });
--------------------------------------------------------------------------------
/utilities.js:
--------------------------------------------------------------------------------
1 | /*
2 | Utility Functions
3 |
4 | Various functions to check the integrity of data.
5 | */
6 | var isString = function(x) {
7 | return x !== null && x !== undefined && x.constructor === String
8 | }
9 |
10 | var isNumber = function(x) {
11 | return x !== null && x !== undefined && x.constructor === Number
12 | }
13 |
14 | var isBoolean = function(x) {
15 | return x !== null && x !== undefined && x.constructor === Boolean
16 | }
17 |
18 | var isObject = function(x) {
19 | return x !== null && x !== undefined && x.constructor === Object
20 | }
21 |
22 | var isArray = function(x) {
23 | return x !== null && x !== undefined && x.constructor === Array
24 | }
25 |
26 | var isDate = function(d) {
27 | if ( Object.prototype.toString.call(d) === "[object Date]" ) {
28 | if ( isNaN( d.getTime() ) ) {
29 | return false;
30 | }
31 | else {
32 | return true;
33 | }
34 | }
35 | else {
36 | return false;
37 | }
38 | }
39 |
40 | var isRealmObject = function(x) {
41 | return x !== null && x !== undefined && x.constructor === Realm.Object
42 | }
43 |
44 | var isRealmList = function(x) {
45 | return x !== null && x !== undefined && x.constructor === Realm.List
46 | }
47 |
48 | var sanitizeFloat = function(number) {
49 | if (isNumber(number)) {
50 | return number;
51 | }
52 | else if (isString(number)) {
53 | let n = parseFloat(number);
54 | if (isNaN(n)) {
55 | return null;
56 | }
57 | else {
58 | return n;
59 | }
60 | }
61 | else {
62 | return null;
63 | }
64 | }
65 |
66 | var sanitizeInt = function(number) {
67 | if (isNumber(number)) {
68 | return number;
69 | }
70 | else if (isString(number)) {
71 | return parseInt(number);
72 | }
73 | else {
74 | return null;
75 | }
76 | }
77 |
78 | var sanitizeString = function(string) {
79 | if (isString(string)) {
80 | return string;
81 | }
82 | else if (isNumber(string)) {
83 | return string.toString();
84 | }
85 | else {
86 | return null;
87 | }
88 | }
89 |
90 | var sanitizeStringNonNull = function(string) {
91 | if (isString(string)) {
92 | return string;
93 | }
94 | else if (isNumber(string)) {
95 | return string.toString();
96 | }
97 | else {
98 | return "";
99 | }
100 | }
101 |
102 | var sanitizeBool = function(bool) {
103 | if (isBoolean(bool)) {
104 | return bool;
105 | }
106 | else if (isNumber(bool)) {
107 | return Boolean(bool);
108 | }
109 | else {
110 | return null;
111 | }
112 | }
113 |
114 | exports.isString = isString;
115 | exports.isNumber = isNumber;
116 | exports.isBoolean = isBoolean;
117 | exports.isObject = isObject;
118 | exports.isArray = isArray;
119 | exports.isDate = isDate;
120 | exports.isRealmObject = isRealmObject;
121 | exports.isRealmList = isRealmList;
122 | exports.sanitizeFloat = sanitizeFloat;
123 | exports.sanitizeInt = sanitizeInt;
124 | exports.sanitizeString = sanitizeString;
125 | exports.sanitizeStringNonNull = sanitizeStringNonNull;
126 | exports.sanitizeBool = sanitizeBool;
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
65 |
66 |
67 |
68 |
69 |
70 |
73 |
74 |
75 |
76 |
303 |
304 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | const express = require('express');
2 | const app = express();
3 | const GitHub = require('octokat');
4 | const Realm = require('realm');
5 | const path = require('path');
6 | const dateFormat = require('dateformat');
7 | const utilities = require('./utilities');
8 | const config = require('./config/config');
9 | const bodyParser = require('body-parser');
10 |
11 | // Realm Model Definition
12 | const TaskSchema = {
13 | name: 'Task',
14 | primaryKey: 'id',
15 | properties: {
16 | text: 'string', // task title
17 | start_date: 'date', // the date when a task is scheduled to begin
18 | duration: 'int', // the task duration
19 | id: 'int', // the task id
20 | body: 'string',
21 | url: 'string',
22 | htmlUrl: 'string',
23 | number: 'int',
24 | // Indicates the state of the issues to return.
25 | // Can be either open, closed, or all.
26 | state: 'string',
27 | isDeleted: 'bool',
28 | // the task type, available values are stored in the types object:
29 | //
30 | // "task" - a regular task (default value).
31 | //
32 | // "project" - a task that starts, when its earliest child task starts, and
33 | // ends, when its latest child ends. The start_date, end_date, duration
34 | // properties are ignored for such tasks.
35 | //
36 | // "milestone" - a zero-duration task that is used to mark out important
37 | // dates of the project. The duration, progress, end_date properties are
38 | // ignored for such tasks.
39 | type: {type: 'string', optional: true},
40 | // the id of the parent task.
41 | // The id of the root task is specified by the root_id config
42 | parent: {type: 'int', optional: true},
43 | // the task's level in the tasks hierarchy (zero-based numbering).
44 | level: {type: 'int', optional: true},
45 | // ( number from 0 to 1 ) the task progress.
46 | progress: {type: 'double', optional: true},
47 | // specifies whether the task branch will be opened initially
48 | // (to show child tasks).
49 | open: {type: 'bool', optional: true},
50 | // the date when a task is scheduled to be completed. Used as an alternative
51 | // to the duration property for setting the duration of a task.
52 | end_date: {type: 'date', optional: true},
53 | // the background color of the task bar
54 | color: {type: 'string', optional: true},
55 | // the label used to identify the color of the task
56 | label: {type: 'string', optional: true},
57 | }
58 | };
59 |
60 | const LabelSchema = {
61 | name: 'Label',
62 | primaryKey: 'id',
63 | properties: {
64 | id: 'int',
65 | url: 'string',
66 | name: 'string',
67 | color: 'string',
68 | default: 'bool',
69 | }
70 | }
71 |
72 | const MilestoneSchema = {
73 | name: 'Milestone',
74 | primaryKey: 'id',
75 | properties: {
76 | url: 'string', //api.github.com/repos/octocat/Hello-World/milestones/1"
77 | htmlUrl: 'string', // https://github.com/octocat/Hello-World/milestones/v1.0"
78 | id: 'int',
79 | number: 'int',
80 | state: 'string',
81 | title: 'string',
82 | description: 'string',
83 | openIssues: 'int',
84 | closedIssues: 'int',
85 | createdAt: 'date',
86 | updatedAt: {type: 'date', optional: true},
87 | closedAt: {type: 'date', optional: true},
88 | dueOn: {type: 'date', optional: true},
89 | }
90 | }
91 |
92 | const gh = new GitHub({
93 | token: config.GITHUB_API_TOKEN
94 | });
95 |
96 | var realm;
97 |
98 | if (config.RMP_ADMIN_TOKEN &&
99 | config.RMP_SYNC_URL) {
100 | if (config.RMP_ADMIN_TOKEN != "" &&
101 | config.RMP_SYNC_URL != "") {
102 | let adminUser = Realm.Sync.User.adminUser(config.RMP_ADMIN_TOKEN);
103 | realm = new Realm({
104 | sync: {
105 | user: adminUser,
106 | url: config.RMP_SYNC_URL,
107 | },
108 | schema: [TaskSchema, LabelSchema, MilestoneSchema],
109 | });
110 | }
111 | }
112 | else {
113 | realm = new Realm({
114 | path: 'tasks.realm',
115 | schema: [TaskSchema, LabelSchema, MilestoneSchema],
116 | });
117 | }
118 |
119 | let repo = gh.repos(config.GITHUB_ORG_NAME, config.GITHUB_REPO_NAME);
120 |
121 | function getLabels(completion) {
122 | repo.labels.fetch()
123 | .then((labels) => {
124 | let items = labels.items;
125 | if (utilities.isArray(items)) {
126 | realm.write(() => {
127 | for (index in items) {
128 | let label = items[index];
129 | realm.create('Label', {
130 | id: label.id,
131 | url: label.url,
132 | name: label.name,
133 | color: label.color,
134 | default: label.default,
135 | }, true);
136 | }
137 | });
138 | }
139 | completion();
140 | });
141 | }
142 |
143 | function getMilestones(completion) {
144 | repo.milestones.fetch()
145 | .then((milestones) => {
146 | let items = milestones.items;
147 | if (utilities.isArray(items)) {
148 | realm.write(() => {
149 | for (index in items) {
150 | let milestone = items[index];
151 | var updatedAt = null;
152 | var closedAt = null;
153 | var dueOn = null;
154 | if (utilities.isString(milestone.updatedAt)) {
155 | updatedAt = new Date(milestone.updatedAt);
156 | }
157 | if (utilities.isString(milestone.closedAt)) {
158 | closedAt = new Date(milestone.closedAt);
159 | }
160 | if (utilities.isString(milestone.dueOn)) {
161 | dueOn = new Date(milestone.dueOn);
162 | }
163 | realm.create('Milestone', {
164 | url: milestone.url,
165 | htmlUrl: milestone.htmlUrl,
166 | id: milestone.id,
167 | number: milestone.number,
168 | state: milestone.state,
169 | title: milestone.title,
170 | description: milestone.description,
171 | openIssues: milestone.openIssues,
172 | closedIssues: milestone.closedIssues,
173 | createdAt: new Date(milestone.createdAt),
174 | updatedAt: updatedAt,
175 | closedAt: closedAt,
176 | dueOn: dueOn,
177 | }, true);
178 | }
179 | });
180 | }
181 | completion();
182 | });
183 | }
184 |
185 | function processIssues(issues, completion, idArray) {
186 | if (!utilities.isArray(idArray)) {
187 | idArray = [];
188 | }
189 |
190 | realm.write(() => {
191 | for (index in issues.items) {
192 | let issue = issues.items[index];
193 | var startDate = new Date(issue.createdAt);
194 | var dueDate = null;
195 | var labelName = null;
196 | var color = null;
197 | var progress = null;
198 |
199 | // find keywords
200 | if (issue.body != null) {
201 | var lines = issue.body.split(/[\r\n]+/);
202 |
203 | for (var j = 0; j < lines.length; j++) {
204 | if (!lines[j].indexOf(config.START_DATE_STRING)) {
205 | let date = new Date(lines[j].replace(config.START_DATE_STRING, ''));
206 | if (utilities.isDate(date)) {
207 | startDate = date;
208 | }
209 | }
210 | if (!lines[j].indexOf(config.DUE_DATE_STRING)) {
211 | let date = new Date(lines[j].replace(config.DUE_DATE_STRING, ''));
212 | if (utilities.isDate(date)) {
213 | dueDate = date;
214 | }
215 | }
216 | if (!lines[j].indexOf(config.LABEL_STRING)) {
217 | var labelString = lines[j].replace(config.LABEL_STRING, '');
218 | if (utilities.isString(labelString)) {
219 | labelString = labelString.trim();
220 |
221 | // Find label in realm
222 | let label = realm.objects('Label').filtered('name = $0', labelString)[0];
223 | if (utilities.isRealmObject(label)) {
224 | color = "#"+label.color.toUpperCase();
225 | labelName = label.name;
226 | }
227 | }
228 | }
229 | if (!lines[j].indexOf(config.PROGRESS_STRING)) {
230 | progress = utilities.sanitizeFloat(lines[j].replace(config.PROGRESS_STRING, ''));
231 | }
232 | }
233 | }
234 |
235 | realm.create('Task', {
236 | text: utilities.sanitizeStringNonNull(issue.title),
237 | start_date: startDate,
238 | duration: 1,
239 | id: issue.id,
240 | body: utilities.sanitizeStringNonNull(issue.body),
241 | url: utilities.sanitizeStringNonNull(issue.url),
242 | htmlUrl: utilities.sanitizeStringNonNull(issue.htmlUrl),
243 | number: issue.number,
244 | state: issue.state,
245 | isDeleted: false,
246 | end_date: dueDate,
247 | label: labelName,
248 | color: color,
249 | progress: progress,
250 | }, true);
251 |
252 | idArray.push(issue.id);
253 | }
254 | });
255 |
256 | if (utilities.isString(issues.nextPageUrl)) {
257 | issues.nextPage.fetch()
258 | .then((moreIssues) => {
259 | processIssues(moreIssues, completion, idArray);
260 | });
261 | }
262 | else {
263 | // Prune the deleted issues
264 | oldIds = realm.objects('Task').map(function(task) {
265 | return task.id;
266 | });
267 |
268 | deletedIds = oldIds.filter(function(el) {
269 | return idArray.indexOf(el) < 0;
270 | });
271 |
272 | realm.write(() => {
273 | for (index in deletedIds) {
274 | let deletedId = deletedIds[index];
275 | let task = realm.objectForPrimaryKey('Task', deletedId);
276 | task.isDeleted = true;
277 | }
278 | });
279 |
280 | completion();
281 | }
282 | }
283 |
284 | function getTaskChartData() {
285 | let tasks = realm.objects('Task').filtered('isDeleted = false AND state = "open" AND end_date != null').sorted('label', true);
286 | var taskData = {data: []};
287 | for (index in tasks) {
288 | let task = tasks[index];
289 | let formattedTask = {
290 | id: task.id,
291 | text: task.text,
292 | start_date: dateFormat(task.start_date, "mm-dd-yyyy"),
293 | duration: task.duration,
294 | end_date: dateFormat(task.end_date, "mm-dd-yyyy"),
295 | url: task.url,
296 | progress: task.progress,
297 | color: task.color,
298 | htmlUrl: task.htmlUrl,
299 | };
300 | taskData.data.push(formattedTask);
301 | }
302 |
303 | return taskData;
304 | }
305 |
306 | app.use('/static', express.static(path.join(__dirname, 'node_modules/dhtmlx-gantt/codebase')));
307 |
308 | app.get('/', function (req, res) {
309 | res.sendFile(path.join(__dirname+'/index.html'));
310 | });
311 |
312 | app.get('/data', function (req, res) {
313 | var taskData = getTaskChartData();
314 | res.send(taskData);
315 | });
316 |
317 | app.get('/additionalData', function (req, res) {
318 | var data = {};
319 |
320 | // Handle milestones
321 | let milestones = realm.objects('Milestone').filtered('dueOn != null');
322 | data.milestones = milestones.map((object) => {
323 | return JSON.stringify(object);
324 | });
325 |
326 | // Handle labels
327 | var hash = {},labels = [];
328 | realm.objects('Task').filtered('isDeleted = false AND state = "open" AND end_date != null AND label != null').sorted('label', true).forEach((object, index) => {
329 | if (!hash[object.label]) {
330 | hash[object.label] = true;
331 | labels.push({
332 | name: object.label,
333 | color: object.color,
334 | });
335 | }
336 | });
337 | data.labels = labels;
338 |
339 | res.send(data);
340 | });
341 |
342 | app.get('/refreshData', function (req, res) {
343 | getLabels(() => {
344 | console.log("--> Retrieved Labels");
345 | });
346 | getMilestones(() => {
347 | console.log("--> Retrieved Milestones");
348 | });
349 | repo.issues.fetch({state: "all", per_page: 100})
350 | .then((issues) => {
351 | processIssues(issues, () => {
352 | console.log("--> Finished Processing Issues");
353 | var taskData = getTaskChartData();
354 | res.send(taskData);
355 | });
356 | });
357 | });
358 |
359 | app.post('/updateIssue', bodyParser.json(), function (req, res) {
360 | if (!req.body || utilities.isObject(req.body)) {
361 | return res.sendStatus(400);
362 | }
363 | let chartTask = req.body;
364 | var task = realm.objectForPrimaryKey('Task', chartTask.id);
365 | if (utilities.isRealmObject(task)) {
366 | // Write to Realm first
367 | realm.write(() => {
368 | task.start_date = new Date(chartTask.start_date);
369 | task.end_date = new Date(chartTask.end_date);
370 | task.duration = utilities.sanitizeInt(chartTask.duration);
371 | task.progress = utilities.sanitizeFloat(chartTask.progress);
372 |
373 | var lines = task.body.split('\r\n');
374 | for (var j = 0; j < lines.length; j++) {
375 | if (!lines[j].indexOf(config.START_DATE_STRING)) {
376 | lines[j] = config.START_DATE_STRING + " " + dateFormat(task.start_date, "mm-dd-yyyy");
377 | }
378 | if (!lines[j].indexOf(config.DUE_DATE_STRING)) {
379 | lines[j] = config.DUE_DATE_STRING + " " + dateFormat(task.end_date, "mm-dd-yyyy");
380 | }
381 | if (!lines[j].indexOf(config.PROGRESS_STRING && utilities.isNumber(task.progress))) {
382 | lines[j] = config.PROGRESS_STRING + " " + task.progress.toFixed(2);
383 | }
384 | }
385 | let newBody = lines.join('\r\n');
386 | task.body = newBody;
387 | });
388 | // Now post to Github
389 | repo.issues(task.number).update({
390 | body: task.body,
391 | }).then((issue) => {
392 | res.send("Success");
393 | });
394 | }
395 | });
396 |
397 | app.listen(process.env.PORT || 3000, function () {
398 | let port = (process.env.PORT || 3000);
399 | console.log('Github-Gantt listening on port ' + port);
400 | });
401 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------