final-commit

README.md

@@ -1 +1,55 @@
-# code-analysis-using-LLM
+# code-analysis-using-LLM
+
+# Source-Code-Analysis-using-GenAI
+
+# How to run?
+### STEPS:
+
+Clone the repository
+
+```bash
+Project repo: https://github.com/
+```
+### STEP 01- Create a conda environment after opening the repository
+
+```bash
+conda create -n llmapp python=3.8 -y
+```
+
+```bash
+conda activate llmapp
+```
+
+
+### STEP 02- install the requirements
+```bash
+pip install -r requirements.txt
+```
+
+
+### Create a `.env` file in the root directory and add your OPENAI_API_KEY credentials as follows:
+
+```ini
+OPENAI_API_KEY = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+```
+
+
+```bash
+# Finally run the following command
+python app.py
+```
+
+Now,
+```bash
+open up localhost:
+```
+
+
+### Techstack Used:
+
+- Python
+- LangChain
+- Flask
+- OpenAI
+- GPT 3
+- ChoromaDB