{"id":17728142,"url":"https://github.com/cinex10/codinsight_api","last_synced_at":"2026-04-15T06:32:44.464Z","repository":{"id":258845381,"uuid":"874998047","full_name":"Cinex10/codinsight_api","owner":"Cinex10","description":"A powerful backend service that powers the Codinsight VS Code extension, helping developers understand code through AI-powered explanations","archived":false,"fork":false,"pushed_at":"2024-10-22T09:14:53.000Z","size":28,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-23T11:35:48.805Z","etag":null,"topics":["code-explainer","coding","llama","llm","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=Cinex10.codinsight","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cinex10.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-18T21:36:46.000Z","updated_at":"2024-10-22T09:16:20.000Z","dependencies_parsed_at":"2024-10-25T23:32:05.817Z","dependency_job_id":null,"html_url":"https://github.com/Cinex10/codinsight_api","commit_stats":null,"previous_names":["cinex10/codinsight_api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cinex10%2Fcodinsight_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cinex10%2Fcodinsight_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cinex10%2Fcodinsight_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cinex10%2Fcodinsight_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cinex10","download_url":"https://codeload.github.com/Cinex10/codinsight_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246498654,"owners_count":20787355,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-explainer","coding","llama","llm","vscode-extension"],"created_at":"2024-10-25T19:05:40.329Z","updated_at":"2026-04-15T06:32:44.391Z","avatar_url":"https://github.com/Cinex10.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codinsight Backend 🧠\n\nA powerful backend service that powers the Codinsight VS Code extension, helping developers understand code through AI-powered explanations.\n\nThe extension is available to use from [this link.](https://marketplace.visualstudio.com/items?itemName=Cinex10.codinsight)\n\n## Overview 🎯\n\nCodinsight is a VS Code extension that provides intelligent code explanations. It leverages Large Language Models to analyze and explain code snippets, making code comprehension faster and easier.\n\nThis repo is the backend of the extension.\n\n## Features ⭐\n\n- Code explanation generation using LLMs\n- Support for multiple programming languages\n- Fast API responses for real-time code analysis\n- Docker containerization for easy deployment\n- Multi-architecture support (AMD64/ARM64)\n\n## Tech Stack 🛠️\n\n- **Framework**: FastAPI, Pydantic\n- **Language**: Python\n- **Database**: MongoDB\n- **Containerization**: Docker\n- **CI/CD**: GitHub Actions\n- **Cloud**: AWS ECR for container registry, AWS ECS for container deployment\n- **AI**: LLM Integration\n\n## Getting Started 🚀\n\n### Prerequisites\n\n- Python 3.9 or higher\n- Docker\n- AWS CLI (for deployment)\n\n### Local Development\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/codinsight.git\ncd codinsight\n```\n\n2. Create and activate a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows: .\\venv\\Scripts\\activate\n```\n\n3. Install dependencies:\n```bash\npip install -r requirements.txt\n```\n\n4. Set up environment variables:\n```bash\ncp .env.example .env\n# Edit .env with your configuration\n```\n\n5. Run the development server:\n```bash\nfastapi dev src/main.py\n```\n\n### Using Docker\n\n1. Build the Docker image:\n```bash\ndocker build -t codinsight .\n```\n\n2. Run the container:\n```bash\ndocker run -p 80:80 --env-file .env codinsight\n```\n\n## API Documentation 📚\n\n### Base URL\n```\nhttp://localhost/\n```\n\n\n## Deployment 🌐\n\nThe project uses GitHub Actions for CI/CD, automatically building and pushing Docker images to Amazon ECR (and Docker hub).\n\nThe project provide Docker images  versionning using specific commit hash for better traceability and reproducibility.\n\n### AWS Setup\n\n1. Create an ECR repository\n2. Configure AWS credentials in GitHub secrets\n3. Set up necessary IAM roles and permissions\n\n### Environment Variables\n\nRequired environment variables:\n```\nDATABASE_URL=\nAPI_V1_STR=\nPROJECT_NAME=\nDESCRIPTION=\nVERSION=\nSECRET_KEY=\nACCESS_TOKEN_EXPIRE_MINUTES=\nALLOWED_ORIGINS=\nAWS_ACCESS_KEY_ID=\nAWS_SECRET_ACCESS_KEY=\nAWS_REGION=\nLLM_API_KEY=\nMODEL=\n```\n\n## Contributing 🤝\n\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request\n\n## License 📄\n\n[Your chosen license]\n\n## Contact 📧\n\nyassine.driss@etu.umontpellier.fr","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcinex10%2Fcodinsight_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcinex10%2Fcodinsight_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcinex10%2Fcodinsight_api/lists"}