Setting up back-end development environment

[atompie]

Setting up back-end development environment

Backend

Prerequisites

Tracardi used elastic search as its storage. Install elastic search or use docker:

Pulling the image

Obtaining Elasticsearch for Docker is as simple as issuing a docker pull command against the Elastic Docker registry. For this you may need docker. If you do not have docker installed take a look here https://docs.docker.com/engine/install/ubuntu/

docker pull docker.elastic.co/elasticsearch/elasticsearch:7.13.2

Starting a single node cluster with Docker

To start a single-node Elasticsearch cluster for development or testing, run:

docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.13.2

This will start elastic at localhost:9200

Optionally you may use docker-compose to start elastic and kibana. Clone tracardi and run:

docker-compose up

Python and Tracardi code

Install python and pip and then:

git clone https://github.com/atompie/tracardi.git
cd tracardi
pip install -r requirements.txt
uvicorn app.main:application --reload --host 0.0.0.0 --port 8001

Go to http://localhost:8001/docs - to see API documentation.

[atompie]

If you find any mistakes or this guide is incomplete please do not be shy and comment below.