Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lgund committed May 30, 2018
1 parent f35ee2a commit 3ad95e9
Showing 1 changed file with 52 additions and 43 deletions.
95 changes: 52 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,75 @@
# First-Coder Teamspeak 3 Webinterface #
###### written by L.Gmann ######
###### Be careful! This version is still in the Alpha / Beta. If you want to have a stable version please use the version 1 of this interface! ######

## About us

First-Coder is a study project, which is specialized to providing you various developments for free,
what would cost normally a lot of money. Realized were a couple of different projects in completely
different programming languages. A view projects in completely different programming languages would
realize.

### Alpha ###
---------------------------------------------------------------------
Version 2 of the Interface is currently preparing for the Closed-Alpha. We are searching for Alphatesters. You can be a part of the Alpha Testers, if you fill out this form: https://goo.gl/forms/jKbaLUfJIi8DpuoL2
## Getting Started

The Interface is able to run on Windows and Linux platforms. This Interface need following configured packages:
* Webserver (apache, nginx, xampp)
* Database (MySQL or PostgreSQL)
* PHP 5.6+
* Basic knowledge of the linux shell (if you´re using a linux server)

### Supported languages

* German
* English

### Prerequisites

Before we start we need to be sure that all packages are installed. We need the php SOAP extension. If you are using Linux pleaes type the following command in you shell. It will install the SOAP extension and restart the webservice.

### Beta ###
---------------------------------------------------------------------
Version 1 of the Interface is currently running in the Open-Beta. Feel free to use it :)
PHP 5.6
```
sudo apt-get install php-soap
sudo systemctl restart apache2.service
```

### Download ###
---------------------------------------------------------------------
The Project is published under GNU GPLv3! You can download the current Version over the Release button or our [Homepage]!
PHP 7.0+
```
sudo apt-get install php7.0-soap
sudo systemctl restart apache2.service
```

### Problems or / and Wishes
---------------------------------------------------------------------
If you have problems or wishes for the interface, so create an issue or contact us over our contact formular [Homepage]
### Installing

### Changelog ###
---------------------------------------------------------------------
***See the [First-Coder-Changelog] for what's new in the most recent release.***
1. Download the Interface from our [Download Homepage](https://first-coder.de/index.php?download)
2. Upload all files into your webserver /var/www/MY-INTERFACE
3. Give the webuser full permissions to the files. You can also give them all 0777 permissions cause after the installation all files will be removed!
4. Open the Link and following the instructions

### Screenshots ###
---------------------------------------------------------------------
Login Area:
![Login Area](https://first-coder.de/images/TSWebinterface/Login.png)
### After installation

Profile:
![Profile](https://first-coder.de/images/TSWebinterface/Profil.png)
After you have installed the Interface you can login and add your instance. You will find it at the right side of you site. Be sure that your Interface is already added in your Teamspeak whitelist. Otherwise the Interface will get banned.

Profile permissions:
![Profile Permissions](https://first-coder.de/images/TSWebinterface/ProfilPermissions.png)
## Built With

Main Settings:
![Main Settings](https://first-coder.de/images/TSWebinterface/Mainsettings.png)
* [Bootstrap v4.0.0](http://getbootstrap.com) - The web framework used
* [ts3admin.class.php](http://ts3admin.info) - Teamspeak framework
* [PHPMailer](https://github.com/PHPMailer/PHPMailer) - Mail lib

Instance Settings:
![Instance Settings](https://first-coder.de/images/TSWebinterface/Instanzsettings.png)
## More information

User Settings 1:
![User Settings 1](https://first-coder.de/images/TSWebinterface/Usersettings1.png)
If you want more information above this Interface please visit our [Homepage](https://first-coder.de). If you have still questions or problems with it please write in our [Forum](https://forum.first-coder.de).

User Settings 2:
![User Settings 2](https://first-coder.de/images/TSWebinterface/Usersettings2.png)
## Authors

TeamSpeak Main Site:
![TeamSpeak Main Site](https://first-coder.de/images/TSWebinterface/TeamspeakHauptseite.png)
* **L. Gmann** - *Developer and Manager*
* **SoulofSorrow** - *Sponsor and Manager*
* **@ndy** - *Forum Manager*

TeamSpeak Info:
![TeamSpeak Info](https://first-coder.de/images/TSWebinterface/TeamspeakInfo.png)
## License

TeamSpeak Mass-Actions:
![TeamSpeak Mass-Actions](https://first-coder.de/images/TSWebinterface/TeamspeakMassenaktionen.png)
This project is licensed under the GNU GPLv3 License - see the [LICENSE.txt](LICENSE.txt) file for details

TeamSpeak Server Create:
![TeamSpeak Server Create](https://first-coder.de/images/TSWebinterface/TeamspeakServerErstellen.png)
## Changelog
You can find [here](https://first-coder.de/index.php?download#changelog) always the up to date changelog

[First-Coder-Changelog]: https://teamspeak.first-coder.de/#changelog
[First-Coder]: https://first-coder.de/
[Homepage]: https://teamspeak.first-coder.de/
## Screenshots
Comming soon...

0 comments on commit 3ad95e9

Please sign in to comment.