Skip to main content

Quick start

This guide will provide you with the quickest default installation for Tikito.

Requirements​

  • Any system will probably do
  • Docker

For a more detailed list of requirements, see the requirements page.

Setup the backend​

Step 1 - Create files​

Create a directory that will contain the docker-compose.yaml and .env files:

Create the directory
mkdir ./tikito
cd ./tikito

Download the docker-compose.yaml and .env files:

Get docker-compose.yml file
wget -O docker-compose.yaml https://raw.githubusercontent.com/Tikito-app/tikito/refs/heads/main/docker-compose.yaml
Get .env file
wget -O .env https://raw.githubusercontent.com/Tikito-app/tikito/refs/heads/main/example.env

Step 2 - Enter the Finnhub token​

Tikito uses Finnhub to get financial information. Don't worry, you can get a free token In the .env file, you have to write the Finnhub token (e.g. 12345):

TIKITO_API_HOSTNAME=http://localhost
TIKITO_API_PORT=4242
TIKITO_UI_PORT=8080

DB_USER=tikito
DB_PASSWORD=some-random-password
FINNHUB_TOKEN=12345

Tikito uses Finnhub to convert an isin to a symbol for stock securities.

Step 3 - Start​

Start the containers:

Start conatiners
docker-compose up -d

Step 4 - Setup of the system​

Open http://localhost:8080 and you will see the screen below to register the admin user.

alt text

Try Tikito​

Try uploading an export of your banking or stock portfolio system.