lychiyu/frequi_origin
1
0
Fork 0
mirror of https://github.com/freqtrade/frequi.git synced 2024-11-25 20:45:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Readme to reflect that developer installation is no longer

Browse Source 
necessary
This commit is contained in:
Matthias 2021-05-08 08:08:55 +02:00
parent 00c15bb0f2
commit 1100e69741
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -6,15 +6,22 @@ Freqtrade UI build with [Vue.js](https://vuejs.org/) and [boostrap-vue](https://
## WARNING ## 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. 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/).
## 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:8081`). You can either use the webpack proxy (port can be changed in `vue.config.js`) - or connect directly to the API (recommended). It will require [freqtrade](https://github.com/freqtrade/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](https://www.freqtrade.io/en/latest/rest-api/#cors).
You will also have to have CORS for freqtrade configured correctly based on the [freqtrade documentation](https://www.freqtrade.io/en/latest/rest-api/#cors).
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. 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. Ports can vary, so check the URL you're using.
## Project setup with node install locally
### Project setup ### Project setup
``` ```