README.md

TeamSpeak Channelcreator

This project automates the process for creating TeamSpeak Channels if needed. It provides a simple user interface to manage the channel manager.

Getting started

Small Note

By default this project can be accessed by everybody. This is OK if you have it only running locally but if you deploy it on a server which is accessible from the web you have to make sure that this project is protected (e.g. with Basic Auth)!

Docker

You can simply pull the provided docker image.

svenc56/teamspeak-channelcreator

Please add the following environment variables depending on your setup:

• SQLite
• MySQL

Installing

1.) Install dependencies:

$ yarn install

2.) Configure Environment Variables

Edit the .env.*.example file with your data.

API Documentation

This application has a full API description available under: /api/swagger

Deployment

$ yarn start:dev

Built With

• Nest.js

Authors

• SvenC56 - SvenC56

License

This project is licensed under the MIT License - see the LICENSE file for details