Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.62 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.62 KB

Code Analyser and Documentation Generator

Overview

This project aims to streamline the process of understanding, setting up, and maintaining code repositories. By analyzing the provided repository, our tool generates comprehensive README and setup files, ensuring that even the most neglected repositories are well-documented and easy to use.

Features

  • Automated Documentation: Automatically generate detailed README files, complete with installation instructions, usage guidelines, and contributor information.
  • Setup Configuration: Create setup files that outline the steps needed to get the project up and running, including dependencies and environment configurations.
  • Code Analysis: Gain insights into the structure and functionality of the codebase, highlighting key components and their interactions.
  • User-Friendly Interface: Easy-to-use interface that guides you through the process of analyzing your code and generating documentation.
  • Customizable Outputs: Tailor the generated documentation to meet your specific needs, with options for different formats and styles.

How It Works

  1. Upload Repository: Provide a link to your GitHub repository or upload the code directly.
  2. Analysis: The tool scans the codebase to understand its structure, dependencies, and key functionalities.
  3. Documentation Generation: Based on the analysis, the tool generates a README file and setup instructions, ensuring that all necessary information is included.
  4. Review and Edit: Review the generated files and make any necessary edits before committing them to your repository.

Tech Stack

  • Frontend: Next.js, Tailwind CSS, Framer Motion
  • Backend: Node.js, Express, LLMs, Python
  • Code Analysis: Static analysis tools, custom parsing algorithms
  • Documentation Generation: Markdown, templating engines

Usage

  1. Clone the repository: 
    git clone https://github.com/C-NikhilKarthik/CodeLens.git
  2. Install dependencies: 
    cd CodeLens
npm install
  3. Start the development server: 
    npm run dev
  4. Open your browser and navigate to http://localhost:3000.

Contributing

We welcome contributions from the community! If you’d like to contribute, please fork the repository and create a pull request with your changes. Make sure to follow our contributing guidelines.

License

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

Contact

If you have any questions or feedback, feel free to reach out to us at [email protected].