Skip to content

rajadilipkolli/mfscreener

 
 

Repository files navigation

Open in Gitpod Quality gateLicense: MIT

mfscreener

Description: MF Screener is a Java-based application designed to provide mutual fund screening capabilities. It allows users to fetch mutual fund data, including historical NAVs, scheme details, and portfolio information, through a set of RESTful APIs.

Setup:

  1. Clone the repository.
  2. Ensure Java 17, docker and gradle are installed.
  3. Navigate to the project directory and follow steps at run-locally to start the application.

Usage:

  • Fetch mutual fund schemes: GET /api/scheme/{schemeName}
  • Upload portfolio details: POST /api/portfolio/upload
  • Calculate XIRR: GET /api/xirr/{pan}

Acronyms

  • ISIN - International Security Identification Number
  • PAN - Personal Account Number
  • CAS - Consolidated Account Statement

Simplified Class Diagram Concept

Loading
classDiagram
    class NAVController {
        +getScheme(schemeCode)
        +getSchemeNavOnDate(schemeCode, date)
    }
    class SchemeController {
        +fetchSchemes(schemeName)
        +fetchSchemesByFundName(fundName)
    }
    class PortfolioController {
        +upload(multipartFile)
        +getPortfolio(panNumber, date)
    }
    class XIRRCalculatorController {
        +getXIRR(pan)
    }
    class SchemeService {
        +fetchSchemeDetails(schemeCode)
        +fetchSchemes(schemeName)
    }
    class PortfolioService {
        +upload(multipartFile)
        +getPortfolioByPAN(panNumber, asOfDate)
    }
    class NavService {
        +getNav(schemeCode)
        +getNavOnDate(schemeCode, inputDate)
    }
    class LocalDateUtility {
        +getAdjustedDate(adjustedDate)
    }
    NAVController --> SchemeService : uses
    SchemeController --> SchemeService : uses
    PortfolioController --> PortfolioService : uses
    XIRRCalculatorController --> NavService : uses
    SchemeService --> LocalDateUtility : uses
    PortfolioService --> LocalDateUtility : uses
    NavService --> LocalDateUtility : uses

This overview and class diagram provide a conceptual understanding of the project's structure. For detailed class relationships and method signatures, please refer to the source code directly.

Run tests

./gradlew clean test integrationTest

Run locally with docker

docker-compose -f docker/docker-compose.yml up -d
./gradlew bootRun -Plocaldocker

Run locally

./gradlew bootRun -Plocal

Using Testcontainers at Development Time

You can run TestApplication.java from your IDE directly. You can also run the application using Gradle as follows:

./gradlew spotlessApply bootTestRun

Useful Links

Check redis keys

  • To check redis keys from docker issue below command
docker exec -it docker-redis-1 redis-cli
127.0.0.1:6379> keys *

how to read CAS Data using casparser

  • Install phyton
  • install casparser using command
    pip install casparser
  • generate json using below command and upload to system
    casparser 42103626220211831ZFFDEPR3H0RBD644686241F761CPIMBCP142488446.pdf -p ABCDE1234F -o pdf_parsed.json
    Here 2nd argument is the path of the pdf file, followed by password of CAS file and the output Type needed

About

Spring Boot REST API which fetches the Net Asset Value(NAV) of an AMFI mutual fund and saves in db

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages