Skip to content

Latest commit

 

History

History
129 lines (82 loc) · 5.46 KB

README.md

File metadata and controls

129 lines (82 loc) · 5.46 KB
Raw

PEATIO v2.0 - An open-source crypto currency exchange

Installation Request or Bug Fixing, fill up this form -

FILL UP THIS REQUEST FORM

Peatio is a free and open-source crypto currency exchange implementation with the Rails framework and other cutting-edge technology.

Mission

Our mission is to build the world best open-source crypto currency exchange with a high performance trading engine and safety which can be trusted and enjoyed by users. Additionally we want to move the crypto currency exchange technology forward by providing support and add new features. We are helping people to build easy their own exchange around the world.

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

Things You Should Know

RUNNING AN EXCHANGE IS HARD.

Peatio makes it easier, but running an exchange is still harder than a blog, which you can download the source code and following the guide or even a cool installer and boom!!! a fancy site is there to profit. We always prioritize security and speed higher than 1-click setup. We split Peatio to many components (processes) so it's flexible to deploy and scalable.

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
  • System administration

Features

  • Designed as high performance crypto currency exchange.
  • Built-in high performance matching-engine.
  • Built-in Proof of Solvency Audit.
  • Built-in ticket system for customer support.
  • Usability and scalibility.
  • Websocket API and high frequency trading support.
  • Support multiple digital currencies (eg. Bitcoin, Litecoin, Dogecoin etc.).
  • Easy customization of payment processing for both fiat and digital currencies.
  • SMS and Google Two-Factor authenticaton.
  • KYC Verification.
  • Powerful admin dashboard and management tools.
  • Highly configurable and extendable.
  • Industry standard security out of box.
  • Active community behind.
  • Free and open-source.
  • Created and maintained by Peatio open-source group.

Known Exchanges using Peatio

Mobile Apps

  • Boilr - Cryptocurrency and bullion price alarms for Android

Requirements

  • Linux / Mac OSX
  • Ruby 2.2.7
  • Rails 4.0+
  • Git 1.7.10+
  • Redis 2.0+
  • MySQL
  • RabbitMQ

** More details are in the doc.

Getting started

API

You can interact with Peatio through API:

Here're some API clients and/or wrappers:

Custom Style

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.
  • Anything you want to tell us please send it to [email protected]
  • If you need technical support or customization service, contact us: [email protected]

License

Peatio is released under the terms of the MIT license. See http://peatio.mit-license.org for more information.