Giter Club home page Giter Club logo

Comments (5)

dealloc avatar dealloc commented on July 17, 2024 4

the steps provided above are basically how to get the API going.
We're setting up more 'advanced' documentation such as Docker etc in #52 so once that's merged we can get this issue started!

from api.

dealloc avatar dealloc commented on July 17, 2024 1

@Stonemercy I added documentation for running containers in d467716
could you get back to me if there's more details you require added?

from api.

v-boivin avatar v-boivin commented on July 17, 2024

The .NET rewrite seems to have removed the docker setup guide

It's available in this previous commit (view the README):
https://github.com/helldivers-2/api/tree/ffea9d9f9e7d5acfea3fc8aa814f4340bb48b273

It would be cool to have a similar guide for the .NET rewrite

from api.

stnokott avatar stnokott commented on July 17, 2024

Should be something along the lines of:

# clone Git repo (including subrepos)
git clone --recurse-submodules https://github.com/helldivers-2/api
# enter newly cloned directory
cd api
# build docker image
docker build -f ./src/Helldivers-2-API/Dockerfile -t helldivers2-api .
# run image
docker run -p 8080:8080 helldivers2-api

Swagger UI is then accessible under http://localhost:4000/swagger-ui.html.

E.g. current war status under http://localhost:4000/api/v1/war.

from api.

Stonemercy avatar Stonemercy commented on July 17, 2024

@Stonemercy I added documentation for running containers in d467716 could you get back to me if there's more details you require added?

Looks great!

from api.

Related Issues (20)

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.