Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardomaia authored Nov 13, 2020
1 parent da2670d commit 2e6c8f3
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,22 +53,27 @@ Set `auto_refresh` true or false to enable or disable page update each 60 second

Finally, `incident_days`, defines the number of days in the issues history to be queried.

Create a `.env` file into root directory and set the `PRODUCTION` property `true` or `false` (development mode). Development mode use a local json file instead of connect GitHub API.:

```
PRODUCTION=true
```
⚠️ Development mode uses a local json file instead of connect GitHub API.

## Building and running in production mode

To create an optimised version of the app:
To create an optimised (production) version of the app:

```bash
npm run build
```

And run it:

```bash
npm run start
```
⚠️ The production mode uses the settings in your `config.json` file and connects to the GitHub API.

## Deploying to GitHub Pages

The command below compiles a production version and push to gh-pages branch of your repository.

```bash
npm run publish
```

0 comments on commit 2e6c8f3

Please sign in to comment.