CryptoCurrency Exchange

Key Features • Built With • Database Schema • API Reference • How To Use • Roadmap

About The Project

Key Features

Note The project is under development so some elements from Key Features are subject to change

• Registration/Login
• Password reset by mail
• Two Factor Authentication
• Trading tokens on the exchange
• Withdrawal/Deposit fiat and crypto
• History of operations
• Referal codes
• Adress book with saved contacts
• Token price flow charts
• Creating signals
• API
• Unit tests
• Typing
• Docstrings
• Format according to PEP8
• ...

Built With

• Python
• Django
• Django REST API
• Pytest
• MySQL
• Bootstrap
• JavaScript
• HTML
• CSS
• HTTP requests
• ...

Database Schema

API Reference

How To Use

To clone and run this application, you'll need Git installed on your computer. Database configuration. From your command line:

# Clone this repository
$ git clone https://github.com/MGasiorowskii/CryptoCurrencyExchange

# Create file .env with the following content
  API_KEY='ENTER YOUR API KEY'
  DEBUG=True
  DATABASE_NAME='YOUR DATABASE NAME'
  DATABASE_USER='YOUR DATABASE USERNAME'
  DATABASE_PASSWORD='YOUR DATABASE PASSWORD'
  DATABASE_HOST='YOUR DATABASE HOST'
  DATABASE_PORT='YOUR DATABASE PORT'

# Go into the repository
$ cd Exchange

# Apply all migrations
$ python manage.py migrate

# Run the app
$ python manage.py runserver

Roadmap

• Registration/Login
• Logout
• Profile
  • User update Form / Profile update Form
  • Change password form
  • Referal codes
  • Adress book with saved contacts
• Password reset by mail
• Two Factor Authentication
• Exchange
  • List of tokens with price
  • Token price flow charts
• Trading tokens on the exchange
• Withdrawal/Deposit fiat and crypto
• History of operations
• Creating signals
• API
• ...

E-mail gasiorowskii.mateusz@gmail.com  ·  GitHub @MGasiorowskii  ·  Linkedin Mateusz Gąsiorowski