Giter Club home page Giter Club logo

skadisteaminventoryproxy's Introduction

SkadisteamInventoryProxy by igeligel

badge Donate badge Donate badge License

Description

A .NET Core Project within a Docker Container to make it possible to easily host a Proxy Service for Steam Community Inventory Requests. It has an integrated In-Memory-Cache which is configurable via the settings file.

Installation

First clone the repository:

git clone https://github.com/igeligel/SkadisteamInventoryProxy.git
cd SkadisteamInventoryProxy

Just run the command:

./build.sh

If you dont have the possibility to run Docker you can run it as normal ASP.NET Core Web Application:

cd src
dotnet restore
dotnet publish -c Release -o out
cd out
dotnet SkadisteamInventoryProxy.dll

For development:

cd src
dotnet restore
dotnet build
dotnet run

How To Use

In the source code of this repository you can find a file called appsettings.inventory.json.

You can set different configurations inside this file. For more documentations check out the docs folder.

After you have applied the settings you can start the application and go to: localhost:5000/api/inventory/76561198028630048/730/2.

The whole API is hosted on Port 5000. If you want to change this, change the Port inside Program.cs.

You can also change the Cache time. The Cache Time describes how long an inventory should be cached. You are also able to exclude several Steam Community Id's from Caching via the configuration file. To get examples of the check out the /docs folder.

To disable the In-Memory-Cache just set the time to 0.

Examples

Contributing

Feel free to contribute. Always check Issues first if something is requested.

Resources

Motivation

Since Steam Community is limiting requests to the inventory endpoint heavily, i was forced to come up with a solution. Since it should be just an easy project you can just get up and running with Docker and configuring the settings file.

Documentation

You can find documentation here.

Contact

Discord server of Kevin Peters Twitter of Kevin Peters Steam Profile of Kevin Peters

Contributors


igeligel

Contributions: 4

License

SkadisteamInventoryProxy is realeased under the MIT License.

This readme is powered by vue-readme

Check out vue-readme [Website | GitHub]

skadisteaminventoryproxy's People

Contributors

igeligel avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

skadisteaminventoryproxy's Issues

Dockerhub

Put the Dockerfile to dockerhub registry for easy installation.

Also include bade in readme afterwards.

Add to zeit

Zeit offers free deployment via a docker container, we can use this to create a live example.

Add API Key functionality

For public projects it might be cool to have an API Interface.

  • Create masterkey field in configuration
  • Create API endpoint to add/delete API Keys with masterkey
  • API Key is needed for inventory request
  • Small Database for API Key save

configuration:

{
  "...",
  apiKeys: {
    enabled: true,
    masterkey: 'dadasdwdawdasdaw'
  }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.