3tinkers / peatio

An open-source Crypto-Currency exchange.

Peatio - an open-source crypto currency exchange

Peatio.tech Introduction

Peatio is a free and open-source crypto currency exchange implementation with the Rails framework. Peatio.tech is a fork of Peatio designed for micro-services architecture, we have simplified the code in order to use only Peatio API with external frontend and server components.

To build your own exchange you should now run Peatio as a backend instead of forking the repository, and extend it using other microservices such as Barong.

Mission

Our mission is to build an open-source crypto currency exchange with a high performance trading engine and safety which can be trusted and enjoyed by users. We moving toward dev/ops best practices of running an enterprise grade exchange.

We provide webminar or on site training for installing, configuring and administation best practices of Peatio. Feel free to contact us for joining the next training session: Peatio.tech

Help is greatly appreciated, feel free to submit pull-requests or open issues.

Requirements

• Linux / Mac OSX
• Docker / Kubernetes
• Ruby 2.5.0
• Rails 4.2+
• Redis 2.0+
• MySQL 5.7
• RabbitMQ

Find more details in the docs directory.

Getting Started

Local development setup:

• Docker compose
• on Mac OS X
• on Ubuntu

Production setup:

• Deploy production cluster with kite
• Kubernetes deployment architecture

Things You Should Know

RUNNING A EXCHANGE IS HARD.

This repository is not a turn key solution and would require engineering and design of security process by your company, with or without our assistance. This repository is one component among many we recommand using for composing an enterprise grade exchange. It's is highly recommanded to deploy a UAT environment and build automated test for your needs, Functional tests, Smoke tests, Security vulnerability scans. You may not need to have active developer on peatio source code and we recommand the following team setup: 1 dev/ops, 3 frontend developers (react / angular), 2 QA engineers, 1 Security Officer.

SECURITY KNOWLEDGE IS A REQUIREMENT.

Peatio cannot protect your customers when you leave your admin password 1234567, or open sensitive ports to public internet. No one can. Running an exchange is a very risky task because you're dealing with money directly. If you don't known how to make your exchange secure, hire an expert.

You must know what you're doing, there's no shortcut. Please get prepared before continue:

• Rails knowledge
• Security knowledge
• Cloud and Linux administration
• Docker and Kubernetes administration
• Micro-services and OAuth 2.0

Features

• Designed as high performance crypto currency exchange
• Built-in high performance matching-engine
• Built-in Proof of Solvency Audit
• Usability and scalibility
• Websocket API and high frequency trading support
• Support multiple digital currencies (eg. Bitcoin, Litecoin, Dogecoin etc.)
• API end point for FIAT deposits or payment gateways.
• Powerful admin dashboard and management tools
• Highly configurable and extendable
• Industry standard security out of box
• Maintained by peatio.tech
• KYC Verification provided by Barong

API

You can interact with Peatio through API:

• API v2 docs
• Websocket API docs

Here're some API clients/wrappers:

• peatio-client-ruby is the official ruby client of both HTTP/Websocket API.
• peatio-client-python by JohnnyZhao is a python client written by JohnnyZhao.
• peatio-client-python by czheo is a python wrapper similar to peatio-client-ruby written by czheo.
• peatioJavaClient is a java client written by classic1999.
• yunbi-client-php is a php client written by panlilu.

Custom Styles

Peatio front-end based Bootstrap 3.0 version and Sass, and you can custom exchange style for your mind.

• change bootstrap default variables in vars/_bootstrap.css.scss
• change peatio custom default variables in vars/_basic.css.scss
• add your custom variables in vars/_custom.css.scss
• add your custom css style in layouts/_custom.css.scss
• add or change features style in features/_xyz.css.scss

vars/_custom.css.scss can overwrite vars/_basic.css.scss defined variables layout/_custom.css.scss can overwrite layout/_basic.css.scss and layoputs/_header.css.scss style

Getting Involved

Want to report a bug, request a feature, contribute or translate Peatio?

• Browse our issues, comment on proposals, report bugs.
• Clone the peatio repo, make some changes according to our development guidelines and issue a pull-request with your changes.
• If you need technical support or customization service, contact us: [email protected]

Getting Support and Customization

If you need help with running/deploying/customizing Peatio, you can contact us on peatio.tech.

Contact us by email: [email protected]

License

Peatio is released under the terms of the MIT license.

What is Peatio?

Peatio (Chinese: 貔貅) is a Chinese mythical hybrid creature considered to be a very powerful protector to practitioners of Feng Shui.

[This illustration copyright for Peatio Team]