frequi_origin/README.md

79 lines
1.5 KiB
Markdown
Raw Normal View History

2020-05-04 04:31:12 +00:00
# frequi
2020-05-14 09:11:57 +00:00
Freqtrade UI build with [Vue.js](https://vuejs.org/) and [boostrap-vue](https://bootstrap-vue.org/).
## WARNING
This project is still in it's early stages, and is not yet stable nor recommended to be used for productiion usages.
It will require Freqtrade to be running on the same host with the API enabled under (`localhost:8081`). This port can be changed in `vue.config.js`.
2020-06-04 09:02:46 +00:00
## Project setup with node install locally
2020-05-14 09:11:57 +00:00
2020-06-04 09:02:46 +00:00
### Project setup
2020-05-18 18:49:30 +00:00
2020-05-04 04:31:12 +00:00
```
npm install
```
### Compiles and hot-reloads for development
2020-05-18 18:49:30 +00:00
2020-05-04 04:31:12 +00:00
```
npm run serve
```
### Compiles and minifies for production
2020-05-18 18:49:30 +00:00
2020-05-04 04:31:12 +00:00
```
npm run build
```
### Lints and fixes files
2020-05-18 18:49:30 +00:00
2020-05-04 04:31:12 +00:00
```
npm run lint
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
2020-06-04 09:02:46 +00:00
## 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
2020-06-04 09:02:46 +00:00
The goal is it have 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.
### Build your dev container
View > Command palette > Enter: Remote-Containers rebuild container
### Serve your local server
2020-06-04 09:02:46 +00:00
```
yarn serve
```
You now have useful vscode extentions, git support, your command history of the project.