mirror of
https://github.com/freqtrade/frequi.git
synced 2024-11-24 20:15:15 +00:00
c72a4826f2
Some checks failed
FreqUI CI / build (18, ubuntu-22.04) (push) Has been cancelled
FreqUI CI / build (20, ubuntu-22.04) (push) Has been cancelled
FreqUI CI / build (22, ubuntu-22.04) (push) Has been cancelled
FreqUI CI / build (23, ubuntu-22.04) (push) Has been cancelled
FreqUI CI / docker (linux/amd64) (push) Has been cancelled
FreqUI CI / docker (linux/arm/v6) (push) Has been cancelled
FreqUI CI / docker (linux/arm/v7) (push) Has been cancelled
FreqUI CI / docker (linux/arm64) (push) Has been cancelled
FreqUI CI / docker-merge (push) Has been cancelled
closes #2133
118 lines
3.5 KiB
Markdown
118 lines
3.5 KiB
Markdown
# FreqUI
|
|
|
|
[](https://open.vscode.dev/freqtrade/frequi)
|
|
|
|
|
|
Freqtrade UI build with [Vue.js](https://vuejs.org/) and [boostrap-vue](https://bootstrap-vue.org/).
|
|
|
|
## 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](https://github.com/freqtrade/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](https://www.freqtrade.io/en/stable/rest-api/).
|
|
|
|
### Running a standalone version of FreqUI
|
|
|
|
Using Docker, you can also run a pre-built docker image of FreqUI.
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
This will start a pre-built container with FreqUI running on port 3000 - which defaults to the latest version of freqUI.
|
|
You can use `docker compose pull` to update to the latest version of the UI.
|
|
|
|
Please note: This is a standalone version of FreqUI, and will still require a correctly configured freqtrade bot.
|
|
You'll need to correctly configure [CORS](https://www.freqtrade.io/en/stable/rest-api/#cors) in freqtrade to allow FreqUI to connect to the API.
|
|
|
|
## Developer project setup
|
|
|
|
It will require [freqtrade](https://github.com/freqtrade/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](https://www.freqtrade.io/en/stable/rest-api/#cors).
|
|
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
|
|
|
|
```
|
|
pnpm install
|
|
```
|
|
|
|
### Compiles and hot-reloads for development
|
|
|
|
```
|
|
pnpm run dev
|
|
```
|
|
|
|
### Compiles and minifies for production
|
|
|
|
```
|
|
pnpm run build
|
|
```
|
|
|
|
### Lints and fixes files
|
|
|
|
```
|
|
pnpm run lint
|
|
```
|
|
|
|
### Build and run docker version
|
|
|
|
```
|
|
docker-compose build
|
|
docker-compose up -d
|
|
|
|
# Access using http://localhost:3000/
|
|
```
|
|
|
|
|
|
### Customize configuration
|
|
|
|
See [Configuration Reference](https://cli.vuejs.org/config/).
|
|
|
|
## 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
|
|
|
|
```
|
|
pnpm run dev
|
|
```
|
|
|
|
## 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](https://code.visualstudio.com/docs/remote/containers#_getting-started) section.
|
|
|
|
### Build your dev container
|
|
|
|
View > Command palette > Enter: Remote-Containers rebuild container
|
|
|
|
### Serve your local server
|
|
|
|
```
|
|
pnpm run dev
|
|
```
|
|
|
|
You now have useful vscode extensions, git support, your command history of the project.
|