Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nipsysdev/vitrine
Generates a static site featuring a trader's performance data.
https://github.com/nipsysdev/vitrine
bybit cryptocurrency static-site-generator trading
Last synced: 11 days ago
JSON representation
Generates a static site featuring a trader's performance data.
- Host: GitHub
- URL: https://github.com/nipsysdev/vitrine
- Owner: nipsysdev
- License: gpl-3.0
- Created: 2024-01-12T23:35:45.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-20T11:21:38.000Z (9 months ago)
- Last Synced: 2024-12-15T00:29:29.997Z (14 days ago)
- Topics: bybit, cryptocurrency, static-site-generator, trading
- Language: TypeScript
- Homepage:
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vitrine
Generates a static site featuring a trader's performance data.
### Supported Brokers
- Bybit
## Requirements
- NodeJS, NPM
- API keys from a supported broker
### Optional (For automatic Github Page deployment)
- Git with SSH profile (Vitrine Page HTTP push untested)
- A Github page repository
## Get Started
### Get Vitrine
- Git Clone (Recommended)
- Zip Download
### Install dependencies
```sh
npm install
```
### Configure Vitrine
Open `vitrine.config.json`. Located at the root of the directory.
#### Required parameters
- `tradersName`: Name of your choice
- `showAvatar`: Whether the file `./public/avatar.png` should be displayed next to your name
- `apiHost`: API base URL
- `apiKey`: API public key
- `apiSecret`: API private key
- `apiRecvWindow`: API recv window
#### Optional parameters
If set, a deployment will be executed at the end of the building process.
- `vitrinePageGitSSH`: SSH path to Github Page repository
- `vitrinePageDomain`: Github Page domain name (to set in CNAME)
#### Example configuration
As an example here is the config that I use.
```json
{
"tradersName": "Xav",
"showAvatar": true,
"apiHost": "https://api.bybit.com",
"apiKey": "xxxx",
"apiSecret": "xxxx",
"apiRecvWindow": 5000,
"vitrinePageGitSSH": "[email protected]:WildXav/vitrine-page.git",
"vitrinePageDomain": "trades.xaviers.sh"
}
```
### Build (& Deploy)
```sh
npm run build
```
## To do
- Dynamically set HTML title
- Bypass PnL retrieval when doing `preview` or `serve`
- TBD