Quickstart

Prerequisites#

Run it#

1. Clone the repository

   TerminalCopy

   git clone https://github.com/flickedgg/FLICKED.git
   cd FLICKED

2. Start the database

   The repository's docker-compose.yml runs PostgreSQL 18 with a development-only password. Create no tables: the API applies its own migrations on startup.

   TerminalCopy

   docker compose up -d

3. Configure and start the backend

   Copy backend/.env.example to backend/.env and fill in a Steam Web API key and your SteamID64. The connection string and Steam:PublicUrl already have development defaults in appsettings.Development.json that match the Docker database.

   backend/.envCopy

   STEAM_API_KEY=YOUR_STEAM_API_KEY_HERE
   FLICKED_ADMIN_STEAM_IDS=YOUR_STEAM_ID_HERE
   
   # Only needed once a real CS2 server has to call you back. In development this
   # is a tunnel whose hostname changes on every restart, so it is not committed.
   FLICKED_API_PUBLIC_URL=https://your-public-api-url.com

   Then start it. The API serves on http://localhost:5165 and applies its migrations on the first run.

   TerminalCopy

   cd backend/Flicked.Api
   dotnet run --launch-profile https

4. Start the launcher

   Leaving FLICKED_API unset builds against http://localhost:5165, which is what you want while developing.

   TerminalCopy

   cd launcher
   npm install
   npm run tauri dev

The website and dashboard#

Both are Next.js apps and run the usual way from their own folders. The dashboard expects the API on http://localhost:5165 and is served on http://localhost:3000, which is the origin the backend allows by default.

cd dashboard   # or: cd website
npm install
npm run dev

To reach the dashboard as an admin, your SteamID64 must be listed in FLICKED_ADMIN_STEAM_IDS.

Play with fewer than ten people#

A real Competitive match needs ten players. While testing alone or with a friend, shrink it:

# a 1v1 is a complete match as far as the matchmaker and rating are concerned
Matchmaking:CompetitivePlayers=2

Everything else, including rating, works unchanged at that size. See Configuration for short-handed matches, which are the production-friendly version of the same idea.

Run the tests#

dotnet test backend

About 70 tests in roughly 30 seconds. They need Docker running because they use a real PostgreSQL database, flicked_test, which the fixture creates and migrates itself. Why real Postgres and not an in-memory provider is explained in Contributing.

Repository layout#

Next steps#