2021-07-30 04:04:54 +00:00
|
|
|
[![Build Status](https://drone.tildegit.org/api/badges/ayham/PaperTrader/status.svg)](https://drone.tildegit.org/ayham/PaperTrader)
|
2020-05-02 11:57:28 +00:00
|
|
|
# PaperTrader
|
|
|
|
The opensource cross-platform paper trader for learning to trade assets.
|
2020-07-23 16:38:01 +00:00
|
|
|
# Getting Started
|
|
|
|
|
|
|
|
## Developers
|
2021-05-19 12:44:18 +00:00
|
|
|
Make Sure you have `Cargo`.
|
|
|
|
To get a copy of the source code for development:
|
2020-07-23 16:38:01 +00:00
|
|
|
```shell
|
|
|
|
$ git clone https://github.com/realaltffour/PaperTrader.git
|
|
|
|
```
|
2021-05-19 12:44:18 +00:00
|
|
|
|
|
|
|
Build command, Server:
|
|
|
|
```shell
|
2021-05-23 04:25:17 +00:00
|
|
|
$ cargo build --no-default-features --features "server"
|
2021-05-19 12:44:18 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
Build command, Client:
|
|
|
|
```shell
|
2021-05-23 04:25:17 +00:00
|
|
|
$ cargo build --no-default-features --features "client"
|
2021-05-19 12:44:18 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
Build command, Hybrid:
|
|
|
|
```shell
|
2021-05-23 04:25:17 +00:00
|
|
|
$ cargo build --no-default-features --features "server,client"
|
2021-05-19 12:44:18 +00:00
|
|
|
```
|
|
|
|
|
2021-05-20 07:39:12 +00:00
|
|
|
Running sandbox:
|
|
|
|
```shell
|
|
|
|
$ sudo ./scripts/remove_db.sh
|
2021-07-01 15:50:50 +00:00
|
|
|
$ sudo ./scripts/deploy_sandbox_db.sh
|
2021-06-25 12:51:42 +00:00
|
|
|
$ ./scripts/deploy_sandbox_server.sh
|
|
|
|
$ ./scripts/deploy_sandbox_client.sh
|
2021-06-02 15:03:42 +00:00
|
|
|
$ cargo run --no-default-features
|
|
|
|
--features "client,tls_no_verify" &
|
2021-05-20 07:39:12 +00:00
|
|
|
```
|
|
|
|
|
2020-07-23 16:38:01 +00:00
|
|
|
## Built With
|
|
|
|
|
|
|
|
* [Rust](https://www.rust-lang.org/) - Language
|
|
|
|
* [Docker](https://www.docker.com/) - Deployment System
|
|
|
|
* [PostgreSQL](https://www.postgresql.org/) - Database System
|
|
|
|
|
|
|
|
## Authors:
|
|
|
|
* **altffour** - *Owner* - [realaltffour](https://github.com/realaltffour)
|
|
|
|
* See also the list of [contributors](https://github.com/realaltffour/PaperTrader/graphs/contributors) who participated in this project.
|
|
|
|
|
|
|
|
## License
|
|
|
|
This project licensed under GPL v3.0 - see the [LICENSE](LICENSE) file for details
|