contrib/benitlux/README.md

   1 An unofficial mailing list and other tools to keep faithful bargoers informed of the beers available at the excellent Brasserie Bénélux.
   2
   3 This project is composed of two softwares:
   4
   5 * a Web interface to subscribe and unsubscribe,
   6 * and a daily background program which updates the BD and send emails.
   7
   8 The web interface is currently published at <http://benitlux.xymus.net/>
   9
  10 # Compile and execute
  11
  12 Make sure all the required packages are installed. Under Debian or Ubuntu, you can use: `apt-get install libevent-dev libsqlite3-dev libcurl4-gnutls-dev sendmail`
  13
  14 To compile, run: `make`
  15
  16 To launch the daily background program, run: `bin/benitlux_daily` (the argument `-e` activates sending emails)
  17
  18 To launch the Web interface, run: `bin/benitlux_web`
  19
  20 The Web interface will be accessible at <http://localhost:8080/>
  21
  22 # Features and TODO
  23
  24 - [x] Web page parser
  25 - [x] Daily mailer
  26 - [x] Web interface
  27 - [x] Serialization and deserialization of data classes
  28 - [ ] Android app
  29 - [ ] iOS app
  30 - [ ] Charlevoix location support
  31 - [ ] Customize mails (daily, on change, per locations)
  32 - [ ] Authenticate unsubscribe actions over GET
  33 - [ ] Social network and location updates
  34 - [ ] Event updates