Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 1.74 KB
Raw

Contributing

First of all thanks a lot for taking the time to contributing to this project. I highly appreciate the effort 🐳

Prerequisites

This app is based on the MERN Webstack. This means you need to install

I would additionally recommend Visual Studio Code as Editor and Yarn as Package Manager.

Working on backend

  1. Open a terminal in /backend and run yarn install (or npm install)
  2. Within /backend create a file with the name .env and insert the following content
TEAMSPEAK_SERVERQUERY_PASSWORD=<YOUR_TS3_SERVERYQUERY_PASSWORD_HERE>
JWT_SECRET=<RANDOM_SECURE_CHAR_SEQUENCE>

To generate the JWT_SECRET you can for example run the following command in a terminal

node -e "console.log(require('crypto').randomBytes(64).toString('base64'));"
  1. Open /backend/util/constants.ts with your favorite Editor and change the variables to your needs. Most likely you have to change __rootChannelId__. This refers to the ID of the TS3 Channel that will be the root of all Channels created by the TS3-Channel-Manager.
  2. You can now start the server by running yarn dev (or npm run dev)

Working on frontend

  1. Open a terminal in /frontend and run yarn install (or npm install)
  2. You can now start the frontend by running yarn start (or npm run start)