https://github.com/csprance/steam-avatar
Fetches a steam avatar using a Steam WEB API key
https://github.com/csprance/steam-avatar
Last synced: about 1 year ago
JSON representation
Fetches a steam avatar using a Steam WEB API key
- Host: GitHub
- URL: https://github.com/csprance/steam-avatar
- Owner: csprance
- Created: 2019-08-24T21:39:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-05T13:33:20.000Z (over 5 years ago)
- Last Synced: 2025-02-06T05:31:05.743Z (over 1 year ago)
- Language: TypeScript
- Size: 149 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Steam Avatar
> A micro-service to return an avatar from steam without exposing an api key.
## How to use
* Rename `.env-example` to `.env` and adjust your secrets
```.env
STEAM_API_KEY=YOURSTEAMWEBAPIKEY
STAGING_HOST=steam-avatars.localhost
PRODUCTION_HOST=steam-avatars.com
```
## Scripts
* `dev` - Watches and compiles the typescript and starts up the micro-dev server
* `start` - Runs the application (It must be built first or this will fail)
* `build` - Builds the application using the Typescript compiler
* `test` - Test with Jest(ts-jest)
## Docker
* Uses Traefik labels
* Runs on port 3000
#### Uses
* micro by zeit