FACEIT BANNER / DOCS
Local setup
You need Node.js, pnpm and your own FACEIT Data API key.
Requirements
- Node.js 22 (the same as in the Dockerfile)
- pnpm, preferably via corepack
- a FACEIT Data API key from developers.faceit.com
Install
corepack enable
pnpm install
cp .env.example .envSet VITE_FACEIT_API_KEY in .env. The variable is baked into the code at build time, so restart the server after changing it. Optionally VITE_IS_TESTING=true shows an "experimental" banner on the page.
Running
pnpm devThe generator runs at http://localhost:5173/ and the widget itself at /widget/index.html with parameters, e.g. ?player_id=...&design=2026&style=showcase. In development the documentation must be generated first with pnpm docs.
Scripts
| Command | What it does |
|---|---|
pnpm dev | Vite dev server (host 0.0.0.0) |
pnpm build | type check, documentation render, production build |
pnpm docs | renders the documentation and the sitemap into public/ |
pnpm lint | ESLint |
pnpm format | Prettier |
pnpm preview | preview of the built version |
Updated: