A Django App

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage

About The Project

We're a trading company and we love cryptocurrencies. We want to give feedback to our users about the value of their portfolios and for that we need to know the price of each cryptocurrency at any given time. For this we have developed a rest api that will be consumed by different applications, webs and mobiles.

(back to top)

Built With

• Django
• Django Rest Framework
• Celery

(back to top)

Getting Started

Installation

This is an example of how to list things you need to use the software and how to install them.

1. create a virtualenv

python3 -m venv currencies-env

2. load virtualenv

source currencies-env/bin/activate

3. clone this repo

git clone git@github.com:sanjmen/currencies

4. change to repo

cd currencies

5. install requirements

pip install -r requirements.txt

6. migrate database

./manage.py migrate

7. run server

./manage.py runserver

8. in other terminal run celery

celery -A apps.taskapp worker -B -l INFO

(back to top)

Usage

1. You can browse the api with the browser

   • open a browser at http://127.0.0.1:8000/api/v1/
   • then you could navigate to markets and klines

2. You can consume it with curl or using your favourite http client

(back to top)