Freqtrade UI - Frontend for Freqtrade
Go to file
Matthias 6748c60fad
Merge pull request #970 from freqtrade/dependabot/npm_and_yarn/main/sass-loader-13.1.0
build(deps-dev): bump sass-loader from 13.0.2 to 13.1.0
2022-10-12 08:10:53 +02:00
.devcontainer Remove vue-cli from docker images 2022-06-13 19:45:18 +02:00
.github FIx ci 2022-06-21 20:04:08 +02:00
cypress Remove sample fixture 2022-09-05 06:51:53 +02:00
docs Update drawio to how pinia is setup 2022-04-26 06:51:04 +02:00
public Switch to vite 2022-02-05 19:28:07 +01:00
src fix for heikin ashi calculation 2022-10-09 12:38:34 +02:00
tests Fix test to use Date 2022-09-14 20:20:15 +02:00
.browserslistrc init 2020-05-04 06:31:12 +02:00
.dockerignore Add production-ready docker file 2020-06-04 12:08:14 +02:00
.editorconfig Rename js files to ts 2020-06-04 20:20:48 +02:00
.eslintrc.js Remove airbnb style from eslint config 2022-02-05 19:34:56 +01:00
.gitignore Fix small bug in handling invalid responses 2022-04-23 10:43:12 +02:00
.prettierrc.json Improve eslint / prettier configuration 2020-05-20 07:23:10 +02:00
cypress.config.ts Rename cypress tests to .cy.ts 2022-06-15 20:16:40 +02:00
docker-compose.yml Update dev port to 3000 2022-02-05 20:13:18 +01:00
Dockerfile build(deps): bump node from 18.9.1-alpine to 18.10.0-alpine 2022-09-29 05:01:26 +00:00
index.html Switch to vite 2022-02-05 19:28:07 +01:00
jest.config.js Try fix test:unit for vite 2022-02-05 19:34:59 +01:00
LICENSE Create License 2020-05-14 11:57:47 +02:00
nginx.conf feat: add support for routes in URL (custom nginx config) 2020-12-03 17:42:16 +01:00
package.json Merge pull request #970 from freqtrade/dependabot/npm_and_yarn/main/sass-loader-13.1.0 2022-10-12 08:10:53 +02:00
README.md Update readme, fixing Open in vscode badge 2022-05-18 09:51:44 +02:00
tsconfig.json Remove comments from tsconfig 2022-07-29 06:34:37 +02:00
vite.config.js Update to vue2.7 2022-07-13 07:34:44 +02:00
yarn.lock Merge pull request #970 from freqtrade/dependabot/npm_and_yarn/main/sass-loader-13.1.0 2022-10-12 08:10:53 +02:00

FreqUI

Open in Visual Studio Code FreqUI CI

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

WARNING

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

Run this project

Using FreqUI, does require freqtrade to be setup and running. In newer versions (2021.2 and newer), freqUI is builtin to freqtrade, so manual setup of freqUI will no longer be necessary unless you want to modify freqUI. Instructions for this end-user setup can be found in the freqtrade API documentation.

Developer project setup

It will require freqtrade to be running on the same host with the API enabled under (localhost:8080). You can either use the webpack proxy (port can be changed in vue.config.js) - or connect directly to the API (recommended).

You will also have to have CORS for freqtrade configured correctly based on the freqtrade documentation. Most likely, the correct entry will be http://localhost:3000 or http://127.0.0.1:3000 - but the URL must match the URL you use to access FreqUI. Ports can vary, so check the URL you're using.

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:3000/

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.