Bauke d630427302 | ||
---|---|---|
src | ||
.eslintrc.json | ||
.gitignore | ||
.gitlab-ci.yml | ||
.stylelintrc.json | ||
README.md | ||
gulpfile.js | ||
package.json | ||
sample-config.json | ||
statistics.js | ||
yarn.lock |
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
- SSH:
- 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 runyarn nodl
to skip the downloading - To easily develop the website itself you can run
yarn watch
to watch thesrc/
folder for changes and automatically lint the sass and build the files. Runningyarn watch
will open your default browser atlocalhost:3000
. - To build the site only once you can do
yarn build
, the files will be built underpublic/
, 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.