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.
55 Commits 1 Branch 0 Tags 7.8 MiB
TypeScript 49.9%
SCSS 29.8%
HTML 18.5%
JavaScript 1.8%
Go to file
Bauke 014c40fc90
Add October 2018 post 		2018-10-31 23:54:13 +01:00
src Add October 2018 post 2018-10-31 23:54:13 +01:00
.eslintrc.json Add ESLint 2018-06-24 20:36:24 +02:00
.gitignore Massive change from Markdown to custom website with Pug & Sass 2018-07-16 03:29:01 +02:00
.gitlab-ci.yml Massive change from Markdown to custom website with Pug & Sass 2018-07-16 03:29:01 +02:00
.stylelintrc.json Massive change from Markdown to custom website with Pug & Sass 2018-07-16 03:29:01 +02:00
README.md Add October 2018 post 2018-10-31 23:54:13 +01:00
gulpfile.js Create and add favicons 2018-07-27 23:53:07 +02:00
package.json Massive change from Markdown to custom website with Pug & Sass 2018-07-16 03:29:01 +02:00
sample-config.json Change template around and remove url from sample-config 2018-06-24 20:16:30 +02:00
statistics.js Minor changes, changed frequent users to ordered list 2018-07-11 00:53:20 +02:00
yarn.lock Update yarn.lock 2018-10-31 14:57:03 +01: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, statistics and/or website 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 dl to download the issues from the current month we're in and build the statistics and issue table, if you already have the issue files you can run yarn nodl to skip the downloading
  • To easily develop the website itself you can run yarn watch to watch the src/ folder for changes and automatically lint the sass and build the files. Running yarn watch will open your default browser at localhost:3000.
  • To build the site only once you can do yarn build, the files will be built under public/, a requirement for GitLab Pages.

A new gitignored directory will be created like data/2018/August and have 2 folders and 2 Pug files.

The folders are for issues both opened or closed during that month table.pug will be the issue table and statistics.pug 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.pug and statistics.pug. This way you don't have to wait several seconds for the GitLab API to respond.

If you want to lint your sass (using Stylelint) manually you can run yarn lint:sass, in the future when we have JavaScript (if ever) there will also be a yarn lint:js task and a general task yarn lint however as there's 0 JS at the moment there's no need for JS linting.