aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2016-11-28 02:28:17 -0600
committerBen Beltran <ben@nsovocal.com>2016-11-28 02:28:17 -0600
commitead516a9d74f346c4556c7eaab7014f95486f29e (patch)
treebab9ac6f7e191e915082e61ff41171412c822061 /README.md
parent927c9aae8b0e28b39f0ee913d9bf53a3c0687e43 (diff)
LGTM-2 Read from database
Squashed commit of the following: commit a2a2b553f69a66f1825347abde4f0028773bdbdb Author: Ben Beltran <ben@nsovocal.com> Date: Mon Nov 28 02:27:19 2016 -0600 Fetch random record in record_fetcher commit 6b98202fc8ea9c5811134cad592f11b6b89d008a Author: Ben Beltran <ben@nsovocal.com> Date: Mon Nov 28 02:27:08 2016 -0600 Add some instructions to the readme commit f5efb2b5de23844e6317a6f636abb75955e60c40 Author: Ben Beltran <ben@nsovocal.com> Date: Mon Nov 28 02:26:57 2016 -0600 Add DB setup script commit d6d8813ef55bb1297089c9dbb87a9ab86e6c5ba2 Author: Ben Beltran <ben@nsovocal.com> Date: Mon Nov 28 02:26:34 2016 -0600 Add dotenv to the configs commit 649f66982d2152d36a782577043505835f235987 Author: Ben Beltran <ben@nsovocal.com> Date: Mon Nov 28 01:29:49 2016 -0600 Use a template instead of static html index
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3f1f2aa..40a517b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
# lgtm
looks good to me
+
+## What you'll need
+
+You should have node and a mysql database where we can create and read a table.
+
+## Configuring the app
+
+The app is configured using environment variables. You can check
+`config/config.js` to see the expected keys. Most values are optional and
+the defaults should work fine, you will have to provide three values for
+the database connection as no defaults are provided:
+
+* `LGTM_MYSQL_USER`
+* `LGTM_MYSQL_PASSWORD`
+* `LGTM_MYSQL_DATABASE`
+
+An easy way to configure this app for local development is by using a `.env`
+file in the project root. An example one is provided in `env.dist`, you can
+copy that file and update with your own defaults.
+
+## Setting Up the Database
+
+Run `npm run setup_database`. This will create the table.