Skip to content

Commit

Permalink
Add docker-compose.yml and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BatteredBunny committed Jun 25, 2023
1 parent 5c16a6a commit 0decaa0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
<h1 align="center">Roblox account value api</h1>

## Simple companion API for the [web app](https://roblox-account-value.sly.ee/)

# Build docker image
This is needed as browser itself can't do many of the requests to roblox so a proxy of sorts is needed.

# Recommended usage
The recommended way to use this is to use the docker image, check the [docker-compose.yml](https://github.com/ayes-web/roblox-account-value-api/blob/master/docker-compose.yml) in the repo :)

# Building docker image with nix
```
nix run github:ayes-web/roblox-account-value-api#docker.copyToDockerDaemon
```

# API
# Building standalone program with nix
```
nix build github:ayes-web/roblox-account-value-api
```


# API
Handy info for utilizing the api yourself
## Account collectibles value API
```
GET https://roblox-account-value-api.sly.ee/api/collectibles-account-value?userid=XXX
Expand Down Expand Up @@ -46,15 +58,4 @@ GET https://roblox-account-value-api.sly.ee/api/exchange-rate
{
"robux_per_euro": 60
}
```

##
# Build program
```
nix build .
```

# Build docker container
```
nix run .#docker.copyToDockerDaemon
```
```
9 changes: 9 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
version: '3.8'

services:
roblox-account-value-api:
image: ghcr.io/ayes-web/roblox-account-value-api:latest
container_name: roblox_account_value_api
ports:
- 8080:80

0 comments on commit 0decaa0

Please sign in to comment.