Giter Club home page Giter Club logo

toxme's Introduction

#ToxMe source

ToxMe is a speedy and feature-packed Tox name resolution server.

##Installing:

Quick notes before we get started, ToxMe's source is not required to access and use it in a client. Additionally, it's being written in OS X and ran on Ubuntu, so please correct any odd quirks I might accidentally include.

###OS X Install homebrew from http://brew.sh

brew install libsodium python3 git libffi
git clone https://github.com/subliun/toxme
pip install -r misc/requirements.txt

And you should be ready!

###Ubuntu Note: we use Ubuntu 14.04

apt-get install python3 python3-pip libffi-dev build-essential wget git sqlite
wget -P /tmp/ https://download.libsodium.org/libsodium/releases/libsodium-1.0.3.tar.gz
cd /tmp/
tar -xvf libsodium-1.0.3.tar.gz
cd libsodium*
./configure --prefix=/usr
make -j4 && make install
cd .. && rm -rf libsodium*
cd ~
git clone https://github.com/subliun/toxme
pip install -r misc/requirements.txt

Optional:

postgres support:

#####OS X brew install postgresql

#####Ubuntu apt-get install libpq-dev

#####All pip install psycopg2

##Getting started:

For most testing and development work you'll need both a config.json and a sqlite3 database.

A sample config.json is provided at misc/config.json

A database can be generated locally by running sqlite3 -init misc/structure.sql database.db ""

Now just run python3 src/main.py and it should start automatically!

##Tips:

If you're testing it locally make sure secure_mode in config.json is marked off (0) otherwise you'll be required to reverse proxy it and use an SSL cert

##Documentation:

toxme's People

Contributors

stqism avatar stal888 avatar subliun avatar urras avatar boreq avatar thelastproject avatar benwaffle avatar davidjfelix avatar aivus avatar zetok avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.