https://github.com/aguxez/valvex
Wrapper for Steam's ReST API in Elixir!
https://github.com/aguxez/valvex
elixir steam
Last synced: over 1 year ago
JSON representation
Wrapper for Steam's ReST API in Elixir!
- Host: GitHub
- URL: https://github.com/aguxez/valvex
- Owner: aguxez
- License: mit
- Created: 2017-05-24T04:04:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-06T23:46:25.000Z (almost 9 years ago)
- Last Synced: 2025-01-26T17:37:15.246Z (over 1 year ago)
- Topics: elixir, steam
- Language: Elixir
- Homepage: https://hexdocs.pm/valvex/Valvex.html
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Valvex
### Valvex is a simple wrapper around the Steam ReST API written in Elixir!
#### Check the [documentation](https://hexdocs.pm/valvex/Valvex.html#content) for the full API reference.
## Installation
First include `Valvex` in your `mix.exs`.
```elixir
{:valvex, "~> 0.3.1"}
```
And make sure that it's initialized before your application:
```elixir
[extra_applications: :valvex, ...]
```
## Usage
Remember to set your the token Steam gives you on your `config.exs`.
```elixir
config :valvex, token: "your-token"
```
Or export the variable name as: `export STEAM_TOKEN="your-token"`.
Then put it on your Supervision tree or something:
```elixir
iex> Valvex.start_link() # If you set the variable before.
iex> Valvex.start_link("your-token") # Pass it directly if you didn't set it before.
```
Now start doing your stuff.
### TODO:
1. There's a module that I didn't complete because I honestly didn't understand it and I didn't want to have it half complete, I just didn't even start it.
[This one](https://github.com/aguxez/valvex/blob/master/lib/valvex/api/stats_game.ex) If you're kind and would like to do it I would have absolutely no problem.
2. Add support for IEconService endpoints.