Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 1.73 KB

README.md

File metadata and controls

68 lines (44 loc) · 1.73 KB

Crypto Dashboard

About

Crypto Dashboard is a TypeScript-based web application built with Node.js and Fastify that fetches data from multiple cryptocurrency exchanges, including Kraken and Binance, and displays it in a centralized dashboard. The purpose of this application is to provide a comprehensive view of your cryptocurrency assets, including spot and staking assets, in one place.

Getting Started

To run the application, you will need to have Node.js (18 or higher) and Docker.

Clone the repository:

~ git clone https://github.com/<username>/crypto-dashboard.git

Server

Install the dependencies by running the following commands:

~ npm install

Create a .env file in the root directory of the project and add your API keys for each exchange. The following variables are required:

KRAKEN_API_KEY=<your-kraken-api-key>
KRAKEN_SECRET=<your-kraken-secret>

Start the server by running the following command. The server will run on http://localhost:3000. The redis client will run on http://localhost:6379.

npm run start

Client

Navigate to client folder and install the dependencies by running the following commands:

~ cd client
~ npm install

Start the client app by running the following command. The application will run on https://localhost:5173.

npm run dev

Currently supported exchanges

Currently supported endpoints

POST /account-balance
POST /staking
POST /trade-history
POST /ledgers

Contributing

Contributions are welcome! If you have any ideas or suggestions for improving the application, please open an issue or submit a pull request.