# northstar

**Repository Path**: lin6he/northstar

## Basic Information

- **Project Name**: northstar
- **Description**: 专为程序员打造的高频量化交易平台，已对接国内期货CTP交易系统
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1950
- **Created**: 2022-05-14
- **Last Updated**: 2022-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Northstar智盈高频量化交易平台

**开源声明：**  
**本项目归入dromara开源组织运营的初心，是希望可以有更多志同道合的朋友一起参与项目的开发，并且能借其在交易市场上有所收获！**  
**借用组织的口号：一个人或许能走的更快，但一群人会走的更远。**  
**本项目仅属于技术分享，不构成任何交易建议。使用者自身在交易前，需要清楚其可能面对的交易风险与相关法律规定，并为自身行为负责！**

这是一个面向程序员的开源高频量化交易平台，尤其适用于高频交易例如炒单、做市商交易、套利等交易模式，也可以用于基于趋势指标的交易模式。用于期货、股票、外汇、炒币等多种投机场景，实现程序化投机。暂时只对接了国内期货交易所，理论上可以对接任意交易所。

![输入图片说明](https://images.gitee.com/uploads/images/2022/0103/205503_efb41f7c_1676852.png "login.PNG")
![Image text](https://images.gitee.com/uploads/images/2021/0609/223845_f3942e1e_1676852.png)

通过JAVA后台来编写程序化的交易策略，并提供页面监控界面。部署方法已集成在本项目的部署脚本中。

![Image](https://images.gitee.com/uploads/images/2021/0606/220710_eeab5dd9_1676852.png)
![Image](https://images.gitee.com/uploads/images/2021/0606/220728_32ef6b37_1676852.png)


项目架构采用事件驱动+插件式开发
![Image](https://images.gitee.com/uploads/images/2021/1107/172130_9da2bdcd_1676852.png)


**开源不易，感谢点赞关注加收藏！**  
**详细文档请参考wiki： https://gitee.com/dromara/northstar/wikis/**

## 适用人群
全栈技术爱好者、小型私募技术团队

## 实盘注意事项
为了更好地了解实盘用户的使用情况，程序对期货公司做了一定的管理，如需要进行实盘交易，请联系作者咨询。

## 社群支持
![输入图片说明](https://images.gitee.com/uploads/images/2022/0107/210113_21d2977f_1676852.jpeg "微信图片_20220107210039.jpg")

## 运行环境
建议使用Linux云服务器，或者Windows系统（MAC系统没有试过，需自行摸索）

## 程序架构
- B/S架构
- northstar项目为服务端（包含了web网页监控端）
- northstar-external为用户自行扩展的项目，可参考[此项目](https://gitee.com/NorthstarQuan/northstar-external)
- 交互协议HTTP + websocket
- 数据库为MongoDB 4.x
- 前端采用node14 + vue2.x
- 服务端采用java17（拥抱新技术） + springboot

## 启动步骤
假设当前环境是全新的服务器  

### 环境准备（只需要运行一次）
**Linux环境下**，初始化系统环境。
```
curl https://gitee.com/dromara/northstar/raw/master/env.sh | sh
```

**Windows环境下**，初始化系统环境。打开powershell命令行窗口，输入以下命令
```
Invoke-WebRequest https://gitee.com/dromara/northstar/raw/master/env.ps1 -OutFile env.ps1; powershell -noexit ".\env.ps1"
```

### 程序包准备
下载最新版项目
[https://gitee.com/dromara/northstar/releases](https://gitee.com/dromara/northstar/releases)

**Linux环境下**
```
cd ~ && wget https://gitee.com/dromara/northstar/attach_files/1008262/download/northstar-3.5.jar
```

**Windows环境下**
```
Invoke-WebRequest https://gitee.com/dromara/northstar/attach_files/1008262/download/northstar-3.5.jar -OutFile northstar.jar
```

### 启动参数准备

**Linux环境下**
在.bashrc中加入启动参数（这样做能隐藏启动参数。若不用邮件通知与不修改默认的登陆账户密码可以不填）  
```
vim ~/.bashrc
```
在文末加入以下设置
```
...
export NSUSER=<登陆用户名>
export NSPWD=<登陆密码>
export SMTP_HOST=<邮箱SMTP，例如smtp.126.com>
export SMTP_SECRET=<邮箱认证码，在邮箱设置中生成的认证码>
export EMAIL=<代理邮箱名> 
export EMAIL0=<订阅邮箱名>
```
保存并退出，然后让配置生效
```
source ~/.bashrc
```

**Windows环境下**
待补充


### 启动程序
**Linux环境下**
```
curl https://gitee.com/dromara/northstar/raw/master/startup.sh | sh
```
注意：startup.sh脚本中包括了JVM的启动参数，假定服务器配置是2核4G，如有不同应该按实际情况自定义启动脚本

**Windows环境下**
待补充

### 部署验证
在浏览器直接访问部署服务的域名（端口使用了默认的80端口）， 应该可以看到以下界面，并可以登陆成功  
**注意：如果是本地的话，请用局域网IP。但不能用localhost与127.0.0.1。**
![输入图片说明](https://images.gitee.com/uploads/images/2022/0103/205503_efb41f7c_1676852.png "login.PNG")

### 查询日志
```
cd ~/logs/
```

### 终止程序
```
kill `pgrep java`
```

## 开发环境配置（Windows环境）
请参考[此文](https://gitee.com/dromara/northstar/wikis/%E5%A6%82%E4%BD%95%E6%90%AD%E5%BB%BA%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83?sort_id=5506194)


## 注意事项
- 请勿直接使用master分支的最新代码，应该使用最新的tag来作为开发基线
- 服务器时间校正为北京时间
- 尽量不要在开市期间重启程序
- 编写策略逻辑时如需使用时间属性，务必使用TICK行情自带的时间戳，否则策略回测时会不准确
- 本项目为量化爱好者及JAVA开发者搭建，对交易行为并不负责
- 当前项目只包含一个示例策略，若要开发其他量化策略，需要自行开发并需要一定的JAVA基础

## 温馨提示
对于仅为了满足交易需求的朋友而言，如果市场上现成的产品可以满足您的策略需求的话，请尽量使用市场上的付费产品例如文华、MC、金字塔等。因为开源项目存在大量的学习与调试成本，除非有成熟的技术背景以及存在付费产品无法实现的策略方案，才建议使用开源方案。

## 特别鸣谢
[redtorch项目](https://github.com/sun0x00/redtorch)作者。本项目演化自redtorch，并保留了小部分其源码，同时感谢redtorch作者的技术分享。