CodeClarity

AI-Powered Code Documentation and Summarization Tool

---

Features

• 🧠 Automated Documentation: Generate detailed docs for any codebase.
• 📝 Code Summarization: Get concise summaries of complex logic.

---

Tech Stack

• Backend: FastAPI (Python)
• Frontend: React (JavaScript)
• AI Models: Vertex AI ( BART)
• Deployment: Google Cloud Platform (GCP)

---

Getting Started

Prerequisites

• Python 3.9+
• Node.js 18+
• Google Cloud Account

Installation

1. Clone the repository:

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

2. Set up the backend:

   cd backend
   pip install -r requirements.txt

3. Set up the frontend:

   cd frontend
   npm install

Running Locally

1. Start the backend:

   cd backend
   uvicorn app.main:app --reload

2. Start the frontend:

   cd frontend
   npm start

3. Open http://localhost:3000 in your browser.

---

Configuration

Create a .env file in the backend directory:

GCP_PROJECT=your-project-id
GCP_REGION=us-central1
GCP_CREDENTIALS=./credentials/service-account.json

---

Deployment

1. Build Docker images:

   docker build -t codeclarity-backend ./backend
   docker build -t codeclarity-frontend ./frontend

2. Deploy to Google Cloud Run:

   gcloud run deploy codeclarity-backend --image codeclarity-backend
   gcloud run deploy codeclarity-frontend --image codeclarity-frontend

---

Contributing

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature

3. Commit your changes:

   git commit -m "Add your feature"

4. Push to the branch:

   git push origin feature/your-feature

5. Open a pull request.

---

License

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

---

Acknowledgments

• Vertex AI for AI models.
• FastAPI for the backend.
• React for the frontend.