https://github.com/bitfinexcom/bfx-report-express
https://github.com/bitfinexcom/bfx-report-express
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitfinexcom/bfx-report-express
- Owner: bitfinexcom
- License: apache-2.0
- Created: 2019-02-04T13:51:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T09:50:55.000Z (about 2 years ago)
- Last Synced: 2024-04-16T10:46:56.720Z (about 2 years ago)
- Language: JavaScript
- Size: 215 KB
- Stars: 3
- Watchers: 5
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# bfx-report-express
## Setup
### Install
- Clone Github repository and install projects dependencies:
```console
git clone https://github.com/bitfinexcom/bfx-report-express.git
cd bfx-report-express
npm install
```
### Configure service
- As to configure the service copy the json.example files from config folder into new ones. Open a console on projects folder a copy the following codes:
```console
cp config/default.json.example config/default.json
```
- To change the api port, client grenache settings or enable logging, change the corresponding properties in the configuration file `config/default.json`
```console
vim config/default.json
## set property values
```
## Other Requirements
### Grenache worker
- Install, configure and run grenache worker following the readme of this repository: [bfx-report](https://github.com/bitfinexcom/bfx-report)
## Run
### Production environment
- For production environment, run the express server in the console:
```console
npm run start
```
### Development environment
- For development environment, run the express server in the console:
```console
npm run startDev
```