https://github.com/elfensky/h1api
This stores historical data from the Helldivers 1 API and functions as a rebroadcaster and cache to prevent the stats page and bot from over-querying the API.
https://github.com/elfensky/h1api
Last synced: 3 months ago
JSON representation
This stores historical data from the Helldivers 1 API and functions as a rebroadcaster and cache to prevent the stats page and bot from over-querying the API.
- Host: GitHub
- URL: https://github.com/elfensky/h1api
- Owner: elfensky
- Created: 2024-12-18T13:11:29.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-16T14:46:13.000Z (3 months ago)
- Last Synced: 2025-02-23T23:08:18.867Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 912 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# h1api
This is a drop-in replacement for services that use the official helldivers1 API.
It acts like a cache and rebroadcaster.
Additionally, it provides new APIs to access historic data.
## requirements
- node@22@lts
- mysql@8
## Setup local environment
1. Install dependencies
```bash
npm i
```
2. Create a `.env` file in the root directory of the project and add the following variables:
```conf
# MYSQL EXAMPLE:
# host.docker.internal is a special hostname that resolves to the internal IP address of the host machine
# DATABASE_URL="mysql://user:[email protected]/database_name"
DATABASE_URL=your-database-url-here
```
3. Run `npm run dev` to start the api with nodemon, which will restart the bot on file changes
4. Run `npm run start` to start the api with node in production mode
## Docker
#### Build local
docker build -t elfensky/h1api:latest .
#### Build production
docker buildx build --platform linux/amd64 -t elfensky/h1api:latest . --push
## Deploy to production
1. docker pull elfensky/h1api:latest
2. create an .env file with the same variables as above and note its path
3. create a docker-compose.yml file with the following content:
```yml
services:
h1api:
image: elfensky/h1api:latest
container_name: h1api # Optional: name your container
ports:
- '52001:3000'
environment:
- DATABASE_URL=${DATABASE_URL} # docker compose will read the .env file
- SENTRY_DSN=${SENTRY_DSN} # docker compose will read the .env file
restart: unless-stopped
network_mode: bridge # Use the default, ufw-whitelisted Docker Network
extra_hosts:
- 'host.docker.internal:host-gateway' # pass the host to container, required on linux
```
4. run `docker-compose up -d` to start the bot
## Updates
1. `docker pull elfensky/h1api:latest` to pull the latest version
2. `docker compose up -d` to recreate and restart the container