Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.37 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.37 KB

AI-Code-Roast

Get your code roasted by AI and learn how to write better code. Built using Python, LangChain, Open AI, and Streamlit. Try it: https://ai-code-roast.streamlit.app/

alt text

Setting up the Project

# Make sure you have Python and Git installed in your machine
# Clone the repo in your repective foler
$ git clone https://github.com/humairshoukat/AI-Code-Roast

# After successfully cloning the repo, go the project folder
$ cd AI-Code-Roast

# Setup the virtual environment
$ python -m venv venv

# Activate the virtual environment
$ venv\Scripts\activate  # For Windows
$ source venv/bin/activate  # For Mac & Linux

# If you're unable to activate the venv OR if you get the error running/execution scripts are disabled,
# If you're using windows, Fix it by following the below instruction:
# Open your Windows Powershell by running it as Administrator and run the following command and enter 'Y':
$ Set-ExecutionPolicy RemoteSigned
# Issue will get fixed, and now activate the virtual environment again and follow the next instructions.

Running the Project

# Install the requirements
$ pip install -r requirements.txt

# Create a .env file by using example.env file from the project files

# Run the app
$ streamlit run app.py

# Your can access the app on the following URL
$ http://localhost:8501/