Comments (5)
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.
@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.
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.
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 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)
- [BUG]: Assignment title not displaying correctly HOT 5
- [FEATURE]: Convert Arrowhead text formatting tags to standard HTML tags. HOT 4
- [FEATURE]: Include data from planet_attacks
- [FEATURE]: Add expiresIn to assignments HOT 1
- [FEATURE]: Add Progress for MO's to v1/assignments HOT 1
- [FEATURE]: provide biome and environment data for planets
- [FEATURE]: Option to fetch all dispatches/assignments in all languages HOT 9
- [FEATURE]: option to increase rate limits HOT 5
- [BUG]: Public SwaggerUI unavailable due to CORS HOT 3
- [BUG]: Dispatches message content occasionally returns null HOT 1
- [BUG]: github.io not redirecting to OpenAPI properly HOT 1
- [BUG]: Dispatches have incorrect publishing date HOT 2
- [FEATURE]: Add warbond endpoints HOT 1
- [BUG]: Possible Resource leak HOT 5
- [FEATURE]: Report metrics on Fly
- [BUG]: Inconsistent data type for Campaign IDs (int32/int64) HOT 1
- [FEATURE]: /docs/ route for swagger documentation HOT 3
- HTTP 500 when no signing key defined HOT 3
- [FEATURE]: make `X-Super-Client` header required HOT 3
- [BUG]: L'estrade sector name typo HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api.