diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -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. |