blob: cfdd2f2bdf9130f5bfb453468e8a790d38a42c54 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# Things To Check
[](https://travis-ci.org/ojacobson/things-to-check)
A friend of mine used to run an IRC bot that could provide "helpful"
troubleshooting suggestions, based on places the folks in that chat had stubbed
their toes in the past.
I thought this was such a good idea, I turned it into a web bot.
## You Will Need
Want to work on this code, or run it yourself? Install the following:
* [An installed copy of the Rust toolchain](https://rustup.rs).
Building, testing, &c follow Rust norms: use
[Cargo](https://doc.rust-lang.org/cargo/guide/working-on-an-existing-project.html)
to build, test, or run the code locally.
## Configuration
By default, this app will listen on `http://localhost:3000/`. You can change the
port number by exporting a `PORT` environment variable in the process where this
program runs.
## Vocabulary
The list of suggestions is given by the `src/things-to-check.yml` file, which
contains a YAML list of strings. Each string is a Markdown snippet to render in
the page as a suggestion.
Stable links provide the user with an index into this list. When you insert new
items, insert them at the end.
|
