So what are we playing?

Playfrens helps you play with friends.
Manage your games library to find, plan, and play together!

Playfrens is the only library manager where you and your friends can organize your shared interest in games, not just ownership, to easily answer questions like:

• 'I'm sitting in a voice chat with two friends. What are all the games we wanted to play?'
• 'Which playthroughs can I continue right now? Which ones were paused, or abandoned?'
• 'Which games am I looking for more people to play with?'
• 'A friend is unavailable. What can we play without them?'
• 'I want to start a new game. Who else wanted to join it?'

Requirements

• Node.js version 20 or above.
• A Supabase project (used as the Postgres database).
• OAuth app credentials for whichever login providers you want working locally: Steam, Google, Discord.
• A SteamGridDB API key used for cover art lookups.

Setup

1. Install dependencies:

    npm install
   

2. Copy .env.example to .env and fill in real values. Each section in the file explains where to get that key.
3. .env.public already contains local defaults, you can adjust if needed but remember to restart the server to see its effects.

Running the Project

• npm run dev - runs the Vite dev server and the Express backend together via Concurrently, both have hot reload.
• npm run dev:vite - frontend only.
• npm run dev:backend - backend only.

By default the app runs at http://localhost:5174 (or https://localhost:5174 if USE_HTTPS=true), with /api and /auth requests proxied to the Express backend on port 3000.

Building for Production

• npm run build - builds the frontend into backend/public, which the Express server serves directly.
• npm run preview - preview the production build locally.

Linting

We use eslint for linting, to run:

npm run lint