lewisl9029/toc-dev repository overview

⁠Dev Environment for Toc Messenger

Commits to this branch will trigger a new Docker Hub Automated Build⁠.

⁠Toc Messenger

VERY ROUGH DRAFT:

An Instant Messaging platform that respects its users.

Designed to protect your privacy. Distributed contact discovery using Bittorrent DHT, end-to-end encrypted message transport using Telehash, allowing you to opt-out of mass surveillance by completely bypassing centralized servers, optional, encrypted, federated user data storage using remotestorage.io.

Designed to preserve your sanity. User-friendly interface, available on all clients, mobile, web, and desktop, all the features you'd expect to see on a modern instant messaging application (multimedia communications, message history, simultaneous login, pseudo offline messaging).

Designed to pave a way towards a better future for messaging applications. Fully open source implementation, well-documented message protocol and data format, designed to be interoperable from the start.

⁠Contributing

⁠Environment Setup

The entire development environment for Toc is fully reproducible using the Vagrantfile and Dockerfile provided in this repository.

The provided Vagrant VM can be used to build the Docker container from the Dockerfile⁠ or pull the Docker container from Docker Hub's automated builds⁠.

Setup instructions:

1. Install Vagrant⁠ and VirtualBox⁠ (VMWare Workstation and Hyper-V have also been configured and tested to work)
2. Clone this repository
3. Open terminal and navigate to this repository
4. Start and provision the development VM and build the docker container:

vagrant up

1. SSH into the development VM:

vagrant ssh

1. To pull the prebuilt container:

toc-pull

To build a container locally from the Dockerfile:

toc-build

1. You're now ready to develop!

There are several aliases provided in the Vagrant VM for quick access to common workflows (such as toc-pull and toc-build above, as well as tasks like serving, building, running the docker container interactively, etc). See their implementations in vagrant-provision.sh⁠.

You can also choose to set up dependencies manually on your machine using the Dockerfile and Vagrantfile in this repository as reference.

⁠License

Copyright (C) 2015 Qi Liu

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.