important-stories-alert-for.../README.md

62 lines
756 B
Markdown
Raw Normal View History

2019-07-29 20:02:33 +02:00
# isahn
2019-08-05 10:32:59 +02:00
Important stories alert for Hacker News.
2019-08-05 11:07:28 +02:00
![Logo isahn](icon.png)
2019-08-05 10:34:52 +02:00
[Telegram channel](https://t.me/important_stories_alert_hacknews)
2019-08-05 10:32:59 +02:00
The entire code in this repository is in charge of feeding the Telegram channel. Every hour check for a new story with more than 600 points in Hacker News.
2019-07-29 20:02:33 +02:00
## Installation
2019-08-04 11:00:35 +02:00
``` sh
2019-08-02 00:01:34 +02:00
cp config-example.edn config.edn
2019-08-04 11:00:35 +02:00
```
2019-07-29 20:02:33 +02:00
2019-08-02 00:01:34 +02:00
## Usage
2019-07-29 20:02:33 +02:00
2019-08-04 11:00:35 +02:00
``` sh
2019-08-05 10:32:59 +02:00
java -jar target/uberjar/isahn-[version]-standalone.jar
```
## Build
Install [Leingengen](https://leiningen.org/) and then...
``` sh
make
2019-08-04 11:00:35 +02:00
```
2019-08-04 11:22:57 +02:00
## Development
### Check format
2019-08-04 11:00:35 +02:00
``` sh
lein cljfmt check
```
2019-08-04 11:22:57 +02:00
### Linter
2019-08-04 11:00:35 +02:00
``` sh
2019-08-04 11:22:57 +02:00
clj-kondo --lint src
2019-08-04 11:00:35 +02:00
```
2019-08-04 11:22:57 +02:00
### Check idiomatic
2019-08-04 11:00:35 +02:00
``` sh
lein auto kibit
```
2019-08-04 11:22:57 +02:00
### Generate doc
``` sh
lein codox
```
2019-08-05 10:32:59 +02:00
### All
``` sh
make check
```