{"id":23167713,"url":"https://github.com/nipsysdev/vitrine","last_synced_at":"2025-10-25T03:30:55.559Z","repository":{"id":216913704,"uuid":"742637904","full_name":"nipsysdev/vitrine","owner":"nipsysdev","description":"Generates a static site featuring a trader's performance data.","archived":false,"fork":false,"pushed_at":"2024-03-20T11:21:38.000Z","size":226,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T23:34:00.401Z","etag":null,"topics":["bybit","cryptocurrency","static-site-generator","trading"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nipsysdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-12T23:35:45.000Z","updated_at":"2024-03-09T23:08:37.000Z","dependencies_parsed_at":"2024-01-29T23:47:34.283Z","dependency_job_id":"b61d61dc-063c-4ed6-a6e8-242f7ed53343","html_url":"https://github.com/nipsysdev/vitrine","commit_stats":null,"previous_names":["wildxav/vitrine","0xnipsys/vitrine","nipsysdev/vitrine"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nipsysdev%2Fvitrine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nipsysdev%2Fvitrine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nipsysdev%2Fvitrine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nipsysdev%2Fvitrine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nipsysdev","download_url":"https://codeload.github.com/nipsysdev/vitrine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238071553,"owners_count":19411604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bybit","cryptocurrency","static-site-generator","trading"],"created_at":"2024-12-18T02:32:51.461Z","updated_at":"2025-10-25T03:30:50.155Z","avatar_url":"https://github.com/nipsysdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vitrine\n\nGenerates a static site featuring a trader's performance data.\n\n### Supported Brokers\n\n- Bybit\n\n## Requirements\n- NodeJS, NPM\n- API keys from a supported broker\n\n### Optional (For automatic Github Page deployment)\n- Git with SSH profile (Vitrine Page HTTP push untested)\n- A Github page repository  \n\n## Get Started\n### Get Vitrine\n- Git Clone (Recommended)\n- Zip Download\n\n### Install dependencies\n```sh\nnpm install\n```\n\n### Configure Vitrine\nOpen `vitrine.config.json`. Located at the root of the directory.\n\n#### Required parameters\n- `tradersName`: Name of your choice\n- `showAvatar`: Whether the file `./public/avatar.png` should be displayed next to your name\n- `apiHost`: API base URL\n- `apiKey`: API public key\n- `apiSecret`: API private key\n- `apiRecvWindow`: API recv window\n\n#### Optional parameters\nIf set, a deployment will be executed at the end of the building process. \n- `vitrinePageGitSSH`: SSH path to Github Page repository\n- `vitrinePageDomain`: Github Page domain name (to set in CNAME)\n\n#### Example configuration\nAs an example here is the config that I use.\n```json\n{\n  \"tradersName\": \"Xav\",\n  \"showAvatar\": true,\n  \"apiHost\": \"https://api.bybit.com\",\n  \"apiKey\": \"xxxx\",\n  \"apiSecret\": \"xxxx\",\n  \"apiRecvWindow\": 5000,\n  \"vitrinePageGitSSH\": \"git@github.com:WildXav/vitrine-page.git\",\n  \"vitrinePageDomain\": \"trades.xaviers.sh\"\n}\n```\n\n### Build (\u0026 Deploy)\n```sh\nnpm run build\n```\n\n## To do\n- Dynamically set HTML title\n- Bypass PnL retrieval when doing `preview` or `serve`\n- TBD","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnipsysdev%2Fvitrine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnipsysdev%2Fvitrine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnipsysdev%2Fvitrine/lists"}