Skip to content

Commit

Permalink
update readme / docker-compose
Browse files Browse the repository at this point in the history
  • Loading branch information
henrygd committed Jan 28, 2024
1 parent 1c1c73d commit b303427
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,25 @@ Website: https://www.ncaa.com/history/bowling/nc

## Deployment

TODO - public docker image
Clone the repo and build the image from the dockerfile:

```bash
docker build -t 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.

## Limiting Access

Expand All @@ -221,10 +239,14 @@ To do this, set the `NCAA_HEADER_KEY` environment variable to the desired value

## Development

This is an [Elysia](https://elysiajs.com/) app. To start the development server run:
This is a minimal [Elysia](https://elysiajs.com/) app. To start the development server run:

```bash
bun run dev
```

TODO - tests
To run tests:

```bash
bun test
```
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: '3.9'

services:
app:
image: 'tbd'
image: 'ncaa-api'
container_name: 'ncaa-api'
ports: ['3000:3000']
# environment:
Expand Down

0 comments on commit b303427

Please sign in to comment.