Fix readme typos

This commit is contained in:
Fausto Gutierrez 2021-01-29 10:45:26 +01:00
parent 0c730c7351
commit af6b49f30e

View File

@ -6,12 +6,12 @@ Freqtrade UI build with [Vue.js](https://vuejs.org/) and [boostrap-vue](https://
## WARNING
This project is still in it's 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 early-alpha), and is not yet stable nor recommended to be used for production usages.
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).
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.
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
@ -62,7 +62,7 @@ cd .devcontainer
docker-compose up -d
```
### Go inside web service container and serve
### Go inside web-service container and serve
```
docker-compose exec web /bin/bash
@ -74,13 +74,13 @@ then
yarn serve
```
## Project setup for vscode and docker (developing inside dev container) on linux
## Project setup for vscode and docker (developing inside dev container) on Linux
The goal is it have a complete dev environment very quickly and isolated.
The goal is it has a complete dev environment very quickly and isolated.
### Install missing tools if needed
Follow [getting strated](https://code.visualstudio.com/docs/remote/containers#_getting-started) section.
Follow [getting started](https://code.visualstudio.com/docs/remote/containers#_getting-started) section.
### Build your dev container
@ -92,4 +92,4 @@ View > Command palette > Enter: Remote-Containers rebuild container
yarn serve
```
You now have useful vscode extentions, git support, your command history of the project.
You now have useful vscode extensions, git support, your command history of the project.