git.r.bdr.sh / rbdr / lgtm / blame
| Commit | Line | Data |
|---|---|---|
| afe2612c RBR |
1 | # lgtm |
| 2 | looks good to me | |
| ead516a9 BB |
3 | |
| 4 | ## What you'll need | |
| 5 | ||
| 6 | You should have node and a mysql database where we can create and read a table. | |
| 7 | ||
| 8 | ## Configuring the app | |
| 9 | ||
| 10 | The app is configured using environment variables. You can check | |
| 11 | `config/config.js` to see the expected keys. Most values are optional and | |
| 12 | the defaults should work fine, you will have to provide three values for | |
| 13 | the database connection as no defaults are provided: | |
| 14 | ||
| 15 | * `LGTM_MYSQL_USER` | |
| 16 | * `LGTM_MYSQL_PASSWORD` | |
| 17 | * `LGTM_MYSQL_DATABASE` | |
| 18 | ||
| 19 | An easy way to configure this app for local development is by using a `.env` | |
| 20 | file in the project root. An example one is provided in `env.dist`, you can | |
| 21 | copy that file and update with your own defaults. | |
| 22 | ||
| 23 | ## Setting Up the Database | |
| 24 | ||
| 25 | Run `npm run setup_database`. This will create the table. | |
| 55fd5e33 BB |
26 | |
| 27 | ## Running | |
| 28 | ||
| 29 | Run `npm start` |