Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 2.54 KB

README.md

File metadata and controls

100 lines (75 loc) · 2.54 KB
Raw
# InsightCode 🧠💻

InsightCode is an AI-powered code review assistant designed to improve code quality through static analysis and natural language feedback. It integrates with GitHub and CI/CD pipelines to provide real-time code review assistance.

🚀 Getting Started

Prerequisites

  • Python 3.8 or later
  • Node.js 14 or later
  • npm (Node Package Manager)
  • Git

Setup Instructions

  1. Clone the Repository:

    git clone https://github.com/yourusername/InsightCode.git
cd InsightCode

  2. Backend Setup:

    • Create and activate a virtual environment: 
      python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
    • Install dependencies: 
      pip install -r backend/requirements.txt
    • Set up environment variables by copying config/settings.py to config/.env and configuring necessary variables.
    • Run the backend server: 
      cd backend
python run.py

  3. Frontend Setup:

    • Navigate to the frontend directory: 
      cd frontend
    • Install dependencies: 
      npm install
    • Start the frontend application: 
      npm start

Running Tests

  • Backend Tests:

    cd backend
pytest

  • Frontend Tests:

    cd frontend
npm test

🔧 CI/CD Configuration

Configuration files for CI/CD are located in the ci_cd/ directory, including GitHub Actions and Jenkins configurations.

🛠️ Scripts

Utility scripts for data preprocessing and model deployment are found in the scripts/ directory.

📜 Documentation

  • Setup Guide: Step-by-step instructions to set up the project.
  • User Guide: Manual for using the InsightCode tool.
  • Best Practices: Guidelines for writing clean, maintainable code.

📁 Configuration Files

  • config/settings.py: Global settings and application configuration.
  • config/secrets.json: Sensitive information like API keys and database credentials.

📜 Logs

Log files are located in the logs/ directory:

  • app.log: Captures application events, errors, and other relevant information.

📑 Contributing

We welcome contributions! Please refer to our contributing guidelines for more details on how to get involved.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy coding! 🎉