Skip to content

Commit

Permalink
ci: add compose.yml file
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmethakanbesel committed Jan 13, 2024
1 parent f25ef90 commit 5c94573
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.github/
ui/
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

## Usage

### Running the Server
### Running the server

#### Download from Releases
#### Download from releases

```bash
./finance-api serve
Expand All @@ -21,7 +21,7 @@
./finance-api serve --http=0.0.0.0:8080
```

#### Run from Source
#### Run from the source

```bash
go run main.go serve
Expand All @@ -30,7 +30,7 @@ go run main.go serve
#### Docker

```bash
docker run -p 8090:8090 -d --name finance-api -e PORT=8090 --restart unless-stopped finance-api
docker compose up -d
```

### Routes
Expand Down Expand Up @@ -60,7 +60,7 @@ http://127.0.0.1:8090/_

Default email is `admin@example.com` and password is `1234567890`.

### Query Parameters
### Query parameters

- `startDate`: Start date of the data to be fetched. Format: `YYYY-MM-DD`
- `endDate`: Optional, if not provided `today` will be used. End date of the
Expand Down
9 changes: 9 additions & 0 deletions compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: "3.7"
services:
api:
build:
context: .
dockerfile: Dockerfile
image: finance-api
ports:
- "8080:8080"

0 comments on commit 5c94573

Please sign in to comment.