https://github.com/tf2pickup-org/server

A server for tf2pickup.org
https://github.com/tf2pickup-org/server

nestjs pickup-game restful-api teamfortress2 tf2 tf2pickup

Last synced: about 1 month ago
JSON representation

A server for tf2pickup.org

• Host: GitHub
• URL: https://github.com/tf2pickup-org/server
• Owner: tf2pickup-org
• License: mit
• Created: 2019-12-23T00:40:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-08T10:14:36.000Z (about 1 month ago)
• Last Synced: 2025-04-14T18:11:57.957Z (about 1 month ago)
• Topics: nestjs, pickup-game, restful-api, teamfortress2, tf2, tf2pickup
• Language: TypeScript
• Homepage: https://tf2pickup.pl/
• Size: 31.4 MB
• Stars: 19
• Watchers: 1
• Forks: 12
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  



The tf2pickup.org server




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





  Documentation »



## About the project

tf2pickup.org was created with a simple objective in mind. Make it as easy and accessible for twelve players to play a 6v6 pick-up game in Team Fortress 2 as possible.

## Local deployment

### Setup

- Clone the repository or download a zipped release of your choice

- Open the terminal inside the repository folder

- Install the dependencies

  ```bash

  $ pnpm install

  ```

- Copy and rename `sample.env` to `.env` and adjust your environment values, mainly:

  - `STEAM_API_KEY` - your [Steam API key](https://steamcommunity.com/dev/apikey), the "Domain Name" can be set to anything you like,

  - `LOGS_TF_API_KEY` - your [logs.tf API key](https://logs.tf/uploader),

  - `SUPER_USER` - your SteamID64,

  - `LOG_RELAY_ADDRESS` - your IP address in the local network.

### Deployment

- Start the required services

  ```bash

  $ docker-compose up -d

  ```

- Finally, run the server in development mode

  ```bash

  $ pnpm dev

  ```

  By default, the server is listening on port 3000 .

## Docker images

```bash

$ docker pull ghcr.io/tf2pickup-org/server:stable

```

### Supported tags

- [`stable`](https://github.com/tf2pickup-org/server/pkgs/container/server/145285422?tag=stable)

- [`latest`](https://github.com/tf2pickup-org/server/pkgs/container/server/145285422?tag=latest)

- [`nightly`](https://github.com/tf2pickup-org/server/pkgs/container/server/148223409?tag=nightly)

## Contact

- Discord: @niewielki

- Steam: