Skip to content

parthakadam2007/SAR-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Suspicious activity report (SAR) Generator (Hack-o-hire)




Live : https://sar-generator.vercel.app/

Inbox Page

Case Investegation Page

SAR Editor




How it works (System architecture)


Getting Started

  1. Clone the repository from GitHub:
git clone https://github.com/parthakadam2007/SAR-Generator
  1. Navigate to the project's root directory:
cd SAR-Generator
  1. Install dependencies & Run app:
cd client
npm install
npm run dev
  1. Set up environment variables: SAR-Generator\backend\python_ai
create .env
  1. install Flyway CLI or desktop

  2. Configure Flyway add flyway.user.toml to SAR-Generator\infra\database\SAR-Generator

  3. go tobackend/main_service/main/java/com/SAR_Generator/resources/application.properties spring.application.name=main_service

  4. PostgreSQL database configuration

$env:DB_URL="jdbc:postgresql://localhost:5432/SAR_Generator"

spring.datasource.url=${DB_URL}
spring.datasource.username=postgres
spring.datasource.password=1234
spring.datasource.driver-class-name=org.postgresql.Driver

### JPA configurations
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.session.jdbc.initialize-schema=always
  1. start all service
docker compose -f infra/docker/docker-compose.dev.yml up

SAR-GENERATOR/
│
├── README.md
├── package.json              # Root scripts (optional - turborepo/nx)
├── .gitignore
├── .env.example
│
├── frontend/                 # React App
│   ├── package.json
│   ├── vite.config.js
│   ├── tsconfig.json
│   │
│   ├── public/
│   └── src/
│       ├── api/              # API clients
│       ├── auth/
│       ├── components/
│       ├── pages/
│       ├── hooks/
│       ├── store/            # Redux/Zustand
│       ├── routes/
│       ├── styles/
│       └── main.tsx
│
├── backend/
│   │
│   ├── api-gateway/          # Entry Point
│   │   ├── Dockerfile
│   │   ├── nginx.conf
│   │   └── main.go / main.js
│   │
│   ├── main-service/         # Case + Orchestration
│   │   ├── app/
│   │   │   ├── controllers/
│   │   │   ├── services/
│   │   │   ├── models/
│   │   │   └── routes/
│   │   ├── Dockerfile
│   │   └── requirements.txt
│   │
│   ├── python-ai/            # ML + Detection
│   │   ├── anomaly/
│   │   ├── rules/
│   │   ├── network/
│   │   ├── pipelines/
│   │   ├── app.py
│   │   ├── Dockerfile
│   │   └── requirements.txt
│   │
│   ├── llm-service/          # LLM Interface
│   │   ├── prompts/
│   │   ├── chains/
│   │   ├── cache/
│   │   ├── main.py
│   │   ├── Dockerfile
│   │   └── requirements.txt
│   │
│   ├── auth-service/         # Auth/RBAC (Optional)
│   │   ├── src/
│   │   ├── Dockerfile
│   │   └── config/
│   │
│   ├── audit-service/        # Logs + Lineage
│   │   ├── logger/
│   │   ├── storage/
│   │   ├── Dockerfile
│   │   └── main.py
│   │
│   ├── ingestion-service/    # ETL / Bank APIs
│   │   ├── connectors/
│   │   ├── workers/
│   │   ├── Dockerfile
│   │   └── main.py
│   │
│   └── shared/               # Shared Libs
│       ├── schemas/          # JSON Schemas
│       ├── proto/            # gRPC (optional)
│       ├── utils/
│       └── constants/
│
├── infra/                    # Infrastructure
│   │
│   ├── docker/
│   │   ├── docker-compose.yml
│   │   └── base-images/
│   │
│   ├── k8s/
│   │   ├── namespaces/
│   │   ├── frontend/
│   │   ├── api-gateway/
│   │   ├── main-service/
│   │   ├── python-ai/
│   │   ├── llm/
│   │   ├── postgres/
│   │   ├── kafka/
│   │   └── redis/
│   │
│   ├── helm/                 # Optional
│   │   └── sar-chart/
│   │
│   └── terraform/            # Optional (Cloud)
│
├── scripts/                  # DevOps tools
│   ├── build-all.sh
│   ├── deploy.sh
│   └── seed-db.py
│
├── docs/                     # Documentation
│   ├── architecture.md
│   ├── api-spec.yaml
│   ├── threat-model.md
│   └── adr/
│
└── tests/                    # Integration Tests
    ├── e2e/
    ├── load/
    └── security/


Contributing

Happy to have you contribute! Please follow these steps:

  1. Fork the repository
  2. Create a new branch for your feature or bugfix:
git checkout -b feature/my-new-feature
  1. Make your changes and commit them:
git add .
git commit -m "Add my new feature"
  1. Push your branch to your fork:
git push origin feature/my-new-feature
  1. Open a pull request against the main repository.

Contact

Parth Kadam

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors