Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Commit

Permalink
Added bash to all triple backticks in README.md fixes #8 (#21)
Browse files Browse the repository at this point in the history
* Add bash to all triple backticks

* Update README.md
  • Loading branch information
nic-dern authored and jameslamb committed Aug 13, 2019
1 parent 3b78443 commit 24e0e21
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ Our motto:

We'll put the container up on Dockerhub soon. For now, you can build locally from this repo.

```
```bash
docker build -t groundhog -f Dockerfile .
```

### Running the app

Run this command to kick up a local version of the app

```
```bash
docker run -p 5005:5005 --name groundhog_server groundhog
```

You can now hit the API on `localhost`. Run the following command in a separate terminal to see the help docs.

```
```bash
curl http://localhost:5005
```

To stop the container by name (if you used the `--name` tag when launching it), do the following:

```
```bash
docker stop groundhog_server
```

Expand All @@ -43,13 +43,13 @@ We provide an R client for the service. Given a `data.table` with GPS informatio

You can install the package from source

```
```bash
R CMD INSTALL r-client/
```

To test it out, spin up a local version of the service, then run this example:

```
```r
library(data.table)

someDT <- data.table::data.table(
Expand All @@ -70,15 +70,15 @@ We provide a Python client for the service. Given a `pandas` `DataFrame` with GP

You can install the package from source

```
```bash
pushd py-client
pip install .
popd
```

To test it out, spin up a local version of the service, then run this example:

```
```python
import pandas as pd
import numpy as np
import groundhog as gh
Expand Down

0 comments on commit 24e0e21

Please sign in to comment.