aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 78103afb374aeafdd2bee1633245827fd250ae05 (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
# 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.

## Running

Run `npm start`