The Portfolio Tracker service is designed to help users monitor their positions and balances across various protocols on the Solana blockchain. It provides an easy-to-use interface for tracking assets, ensuring that users can keep tabs on their investments with minimal hassle.

• Ensure you have Python installed (preferably 3.8 or higher).
• Docker should be installed if you prefer running the service using Docker.

1. Create a .env file in the root directory of the project.
2. Add the following fields to the .env file, replacing <API_KEY> with your actual API keys:

   SOLANA_MAINNET_RPC_URL=https://mainnet.helius-rpc.com/?api-key=<API_KEY>
   SOLANA_DEVNET_RPC_URL=https://devnet.helius-rpc.com/?api-key=<API_KEY>

First, install the necessary dependencies:

pip install -r requirements.txt

You can start the service using either of the following methods:

• Using Bash:

  bash deployment/app.sh

• Using Gunicorn directly:

  gunicorn main:app

Build the Docker image:

docker build -f deployment/Dockerfile . -t quant-portfolio

Run the Docker container:

docker run -p 8000:8000 --env-file .env quant-portfolio

Pull the pre-built Docker image from GitHub Container Registry:

docker pull ghcr.io/crypto_quants/portfolio_tracker:<TAG>

Run the Docker container:

docker run -p 8000:8000 --env-file .env ghcr.io/crypto_quants/portfolio_tracker:<TAG>

Once the service is running, you can access the Swagger documentation to explore the API endpoints and test the service.

• Open your web browser and navigate to:

  http://localhost:<PORT>/docs
  

Feel free to raise issues in the repository. Happy tracking!