death-notifier/README.md

44 lines
1003 B
Markdown
Raw Normal View History

2022-11-12 14:18:00 +01:00
# Death Notifier
Get notified when a famous person dies.
Wikipedia's editors [are known](https://knowyourmeme.com/memes/wikipedia-editors-when-someone-dies) for updating pages
as soon as someone has passed away.
Why not turn that into a service?
This tool regularly checks if people are still alive according to Wikipedia, and emails you as soon as that changes.
## Development
### Requirements
* [composer](https://getcomposer.org/)
* [npm](https://www.npmjs.com/)
### Setting up
```shell script
# Install dependencies (only needed once)
$> composer.phar install
$> npm ci
```
### Building
```shell script
# Build the tool in `dist/` for development
$> npm run dev
# Same as above, but automatically rerun it whenever files are changed
$> npm run dev:server
# Build the tool in `dist/` for deployment
$> npm run deploy
```
### Pre-commit
```shell script
# Update lock files
$> composer.phar update
$> npm install
```
### Static analysis
```shell script
# PHP static analysis
$> npm run stan
```