Bauke/tildes-issue-log
Bauke
/
tildes-issue-log
Archived
1
Fork 0
Code Releases Activity
Archive of the Tildes Issue Log.
This repository has been archived on 2022-10-04. You can view files and clone it, but cannot push or open issues or pull requests.
21 Commits 1 Branch 0 Tags 7.8 MiB
TypeScript 49.9%
SCSS 29.8%
HTML 18.5%
JavaScript 1.8%
Go to file
Bauke a1804e6ea2
Separate statistics functions from main.js 		2018-06-26 19:26:53 +02:00
2018 Add daily discussions table, fixes #4 2018-06-26 17:47:40 +02:00
.eslintrc.json Add ESLint 2018-06-24 20:36:24 +02:00
.gitignore Initial commit with May entry 2018-06-24 18:38:50 +02:00
README.md Add contributing and building sections to README 2018-06-25 00:56:52 +02:00
main.js Separate statistics functions from main.js 2018-06-26 19:26:53 +02:00
package.json Add ESLint 2018-06-24 20:36:24 +02:00
sample-config.json Change template around and remove url from sample-config 2018-06-24 20:16:30 +02:00
statistics.js Separate statistics functions from main.js 2018-06-26 19:26:53 +02:00
template.md Add daily discussions table, fixes #4 2018-06-26 17:47:40 +02:00
yarn.lock Add ESLint 2018-06-24 20:36:24 +02:00

README.md

Tildes Issue Log

2018

Contributing

If you'd like to write a highlight section about a feature, please do! I'm not a writer by any means and would love to have other people write these instead. If you're not familiar with the Git workflow you can always private message me with what you've written and I'll add your section for you, crediting your Tildes profile. If you'd like to learn Git, you can find tons of guides online. Here's an excellent one.

Building

If you'd like to build the issue table and/or statistics yourself you can follow these steps.

You'll need Node JS and Yarn. You can use NPM however I don't. You probably know what you're doing though at that point.

  • Clone the repository
    • SSH: git clone git@gitlab.com:Bauke/tildes-issue-log.git
    • HTTPS: git clone https://gitlab.com/Bauke/tildes-issue-log.git
  • Change into the directory: cd tildes-issue-log
  • Install the dependencies: yarn
  • Create a config.json file from the sample config, including a personal access token from GitLab. config.json is gitignored however make sure you don't publish your token somewhere on accident.
  • Run yarn start to download the issues from the current month we're in.

This will create a new directory like 2018/August and have 2 folders and 3 markdown files.

The folders are for issues both opened or closed during that month and are gitignored. post.md will be the same as template.md unless it already exists. table.md will be the issue table. statistics.md will be the statistics.

If you're working on the generation process you can run yarn nodl to skip the downloading phase, this will only generate table.md and statistics.md. This way you don't have to wait several seconds for the GitLab API to respond.