diff --git a/README.md b/README.md index 5872f7e..582c7b9 100644 --- a/README.md +++ b/README.md @@ -1 +1,50 @@ -# Credit-card-kafka \ No newline at end of file + +# Fraudulent Credit Card Transaction detection in real time using Kafka + +Utilized SparkML and Scikit-Learn to develop and train several machine learning +models for distinguishing fraudulent and legitimate transactions. +The machine learning models are then utilized to make predictions on Kafka-generated real-time data streams. +Built an interface for displaying these predictions in real time using Streamlit framework. + + +[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) +![issues](https://img.shields.io/github/issues/ashwinn-v/Photoshop-App) +![forks](https://img.shields.io/github/forks/ashwinn-v/Photoshop-App) +![stars](https://img.shields.io/github/stars/ashwinn-v/Photoshop-App) + + + +## Installation steps + +#### Install Anaconda + +``` + https://www.anaconda.com/products/individual +``` + + +#### Create a conda environment and activate it + +``` + $ conda create streamlitapp + $ conda activate streamlitapp +``` + +#### Install required packages from requirements.txt + +``` + # Clone this repository + $ cd + $ pip install -r requirements.txt +``` + +#### Run the streamlit app + +``` + $ streamlit run app.py +``` + + +## 🛠 Tools +Streamlit, PySpark, Kafka, Python +