Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 3.08 KB

README.md

File metadata and controls

108 lines (83 loc) · 3.08 KB

English | 简体中文

Online Config Page

🔥 Features

  • Dynamic: The card content will be dynamically generated according to your Steam status.
  • User Friendly: Generate your Steam card on Online Config Page
  • i18n: Support multiple languages (PR Welcome for more language)
  • Customizable: Support more than 10 Custom items.
  • Deployable: Support deploy it with Vercel, Netlify, Railway or Docker.

📦 Deployment

Note Card information will be automatically update every 24 hours. If your want a shorter update time, deploy it by your self.

Environment Variables

Name Description Example
NUXT_STEAM_KEY Steam Api Key 5B23D7ECExxxxxxB58C57BC242
NUXT_CACHE_TIME request cache time (second) 3600

PaaS

Deploy with Vercel

Netlify

Deploy on Railway

Deploy on Zeabur

Docker

docker pull lyc575757/steam-card
docker run -d \
-e NUXT_STEAM_KEY=5B23D7ECE730xxxxxxxxx57BC242 \
-e NUXT_CACHE_TIME=3600 \
-p 3000:3000 \
lyc575757/steam-card

⚒️ Develop

Requirement:

Node >=16

Steam Api Key

# copy a .env file
cp .env.example .env

Add your Steam API KEY on .env file

NUXT_STEAM_KEY=YOUR_STEAM_KEY
# install dependencies
pnpm install 
# or
yarn install
# or
npm install

# start the service
npm run dev

❤️ Credits

Inspired by github-readme-stats