Skip to content

Commit

Permalink
refractor: update all references to old organization name (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
fabio-nettis authored Mar 20, 2024
1 parent 1b99839 commit 3cbd934
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 13 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<p align="center">
<img src="./assets/logo-light.png#gh-light-mode-only" width="218px" alt="Helldivers Companion logo" />
<img src="./assets/logo-dark.png#gh-dark-mode-only" width="218px" alt="Helldivers Companion logo" />
<img src="./assets/logo.png" width="150px" alt="HellHub Logo" />
</p>

<h3 align="center">The official API for the community driven Helldivers Companion app.</h3>
<h3 align="center">The Official API For The Community Driven HellHub App.</h3>
<p align="center">Written 100% in Typescript, running on Bun. Pulls data from the official API and acts as cache/transformer relay.</p>

<br>

## Whats is the Helldivers Companion API?
## Whats is the HellHub API?

The unofficial API was not explicitly made usable by Arrowhead Game Studios for third parties, may be subject to change at any time. This API will be updated to reflect any changes to the game API.

Expand All @@ -18,7 +17,7 @@ The API is written in Typescript and runs on the Bun framework. It pulls data fr

## Rate limit

The Helldivers Companion API has a rate limit of 200 requests per minute. To avoid hitting rate limits in your clients check the following headers in your response:
The HellHub API has a rate limit of 200 requests per minute. To avoid hitting rate limits in your clients check the following headers in your response:

- `X-Rate-Limit`: The maximum number of requests per minute.
- `X-Rate-Count`: The number of requests made in the current minute.
Expand All @@ -27,7 +26,7 @@ The Helldivers Companion API has a rate limit of 200 requests per minute. To avo

## API Entities and Endpoints

We have a few entities that we can interact with in the API. Here is a brief overview of each of them. These are all created from the source data of the Helldivers 2 API and merely modified to be more usable.
For the full full documentation, check out the [postman collection](./postman.json) inside the repository root.

### Sectors

Expand Down
Binary file removed assets/logo-dark.png
Binary file not shown.
Binary file removed assets/logo-light.png
Binary file not shown.
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@helldivers-companion/api",
"description": "The official API for the community driven Helldivers Companion app",
"name": "@hellhub/api",
"description": "The official API for the community driven HellHub app",
"module": "./src/index.ts",
"main": "build/index.mjs",
"types": "build/index.d.ts",
Expand All @@ -24,7 +24,7 @@
"dev": "bun run --hot ./src/index.ts",
"refresh": "bun run ./scripts/refresh.ts",
"clean": "rm -rf prisma/database prisma/migrations",
"serve": "pm2 start --name=\"@helldivers-companion/api\" --interpreter ~/.bun/bin/bun build/index.js",
"serve": "pm2 start --name=\"@hellhub/api\" --interpreter ~/.bun/bin/bun build/index.js",
"generate": "bun run ./scripts/generate.ts"
},
"devDependencies": {
Expand Down
6 changes: 3 additions & 3 deletions postman.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"info": {
"_postman_id": "92940ded-affa-4260-a27b-f12888c76b5d",
"name": "Helldivers Companion API",
"description": "## Whats is the Helldivers Companion API?\n\nThe API is written in Typescript and runs on the Bun framework. It pulls data from the Helldivers 2 API and transforms it into a more user-friendly format. It also caches the data so that the app can pull data from the API without having to worry about rate limits or slow response times.\n\n## Statement\n\nThe unofficial API was not explicitly made usable by Arrowhead Game Studios for third parties, may be subject to change at any time. This API will be updated to reflect any changes to the game API.",
"name": "HellHub API",
"description": "## Whats is the HellHub API?\n\nThe API is written in Typescript and runs on the Bun framework. It pulls data from the Helldivers 2 API and transforms it into a more user-friendly format. It also caches the data so that the app can pull data from the API without having to worry about rate limits or slow response times.\n\n## Statement\n\nThe unofficial API was not explicitly made usable by Arrowhead Game Studios for third parties, may be subject to change at any time. This API will be updated to reflect any changes to the game API.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "6421438"
},
Expand Down Expand Up @@ -4390,7 +4390,7 @@
},
{
"key": "api_url",
"value": "https://api-helldivers-companion.koyeb.app",
"value": "https://api-hellhub-collective.koyeb.app",
"type": "string"
}
]
Expand Down
1 change: 0 additions & 1 deletion src/routes/stratagems.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ export default async function stratagems(app: Hono) {
app.get("/stratagems", Stratagems.getAllStratagems);
app.get("/stratagems/:id", Stratagems.getStratagemById);
}
//https://api-helldivers-companion.koyeb.app

0 comments on commit 3cbd934

Please sign in to comment.