frequi_origin/README.md
Fausto Gutierrez c74a8f678a
Update README.md
I agree

Co-authored-by: Matthias <xmatthias@outlook.com>
2021-01-29 11:22:22 +01:00

2.2 KiB

frequi

FreqUI CI

Freqtrade UI build with Vue.js and boostrap-vue.

WARNING

This project is still in its early stages (consider it early-alpha), and is not yet stable nor recommended to be used for production usages.

It will require freqtrade to be running on the same host with the API enabled under (localhost:8081). You can either use the webpack proxy (port can be changed in vue.config.js) - or connect directly to the API (recommended). FOr this, you will also have to have CORS configured correctly freqtrade documentation. Most likely, the correct entry will be http://localhost:8080 or http://127.0.0.1:8080 - but the URL must match the URL you use to access FreqUI. Ports can vary, so check the URL you're using.

Project setup with node install locally

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Build and run docker version

docker-compose build
docker-compose up -d

# Access using http://localhost:8080/

Customize configuration

See Configuration Reference.

Project setup for docker (developing inside dev container) without vscode

Built dev docker image and run container(s) detached

cd .devcontainer
docker-compose up -d

Go inside web-service container and serve

docker-compose exec web /bin/bash

then

yarn serve

Project setup for vscode and docker (developing inside dev container) on Linux

The goal is to have a complete dev environment very quickly and isolated.

Install missing tools if needed

Follow getting started section.

Build your dev container

View > Command palette > Enter: Remote-Containers rebuild container

Serve your local server

yarn serve

You now have useful vscode extensions, git support, your command history of the project.