Skip to content

Commit

Permalink
Update deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
henrygd committed Jan 30, 2024
1 parent 16731f4 commit 4ed2809
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,25 +211,13 @@ Website: https://www.ncaa.com/history/bowling/nc

## Deployment

Clone the repo and build the image from the dockerfile:
Use the included [docker-compose.yml](/docker-compose.yml) or run directly with docker:

```bash
docker build -t ncaa-api .
docker run -p 3000:3000 henrygd/ncaa-api
```

Run the image:

```bash
docker run -p 3000:3000 ncaa-api
```

Or use the included [docker-compose.yml](/docker-compose.yml) file:

```bash
docker-compose up
```

The API should be available at http://localhost:3000.
The app should be available at [http://localhost:3000](http://localhost:3000/history/bowling/nc).

## Limiting Access

Expand All @@ -250,3 +238,5 @@ To run tests:
```bash
bun test
```

Contributions welcome.

0 comments on commit 4ed2809

Please sign in to comment.