https://github.com/codedust/webtox
A web based graphical user interface for Tox - contributions welcome!
https://github.com/codedust/webtox
Last synced: 5 months ago
JSON representation
A web based graphical user interface for Tox - contributions welcome!
- Host: GitHub
- URL: https://github.com/codedust/webtox
- Owner: codedust
- License: gpl-3.0
- Created: 2014-10-14T13:35:14.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-01-03T20:06:45.000Z (about 10 years ago)
- Last Synced: 2025-04-05T12:33:36.478Z (10 months ago)
- Language: Go
- Homepage:
- Size: 850 KB
- Stars: 50
- Watchers: 8
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
WebTox
======
WebTox is a web-based Tox client written in [go](https://golang.org/) (server-side) and html5 (client-side).
WebTox isn't ready yet! Please **don't use WebTox** if you don't know the risks of using unstable software.
When you should(n't) use WebTox
-------------------------------
You should use WebTox if
- you would like to use Tox on any currently unsupported plattform that comes with support for web-based applications.
- you are able to install it on your Raspberry Pi or any similar hardware.
- you want to install it locally because you like web applications. ;)
You should **not** use WebTox if
- you don't trust the server you would like to install it on.
- you just want to use Tox as a normal desktop application and don't care about the technical details.
- you have never heard of "Port Forwarding" and "DynDNS".
If WebTox does not fit your requirements, try out one of the [recommended Tox clients for your plattform](https://wiki.tox.chat/Binaries).
How to run
----------
If you are unfamiliar with Go, please start by reading [How to Write Go Code](http://golang.org/doc/code.html).
First of all, you have to install [toxcore](https://github.com/irungentoo/toxcore/).
If you haven't set up your go environment yet, here is how to do so:
```bash
mkdir -p ~/go
export GOROOT=~/go
export PATH=$PATH:~/go/bin
echo "export GOPATH=~/go/" >> ~/.bash_profile
echo "export PATH=$PATH:~/go/bin" >> ~/.bash_profile
```
The easiest way to run WebTox is using the go tools:
```bash
go get github.com/codedust/WebTox
go get github.com/codedust/go-tox
go get github.com/codedust/go-httpserve
go get github.com/mattn/go-sqlite3
```
WebTox can now be started simply by running `go run *.go` from within the `server` directory. Next, visit [http://localhost:8080/](http://localhost:8080/) and you are done.
Contributing
------------
Yay! Thanks. Any contribution is helpful. If you plan to start a huge change, it might be the best to create a Github Issue first.
License
-------
WebTox is released under the GNU General Public License v3.