Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janani1727/codeaudit
https://github.com/janani1727/codeaudit
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/janani1727/codeaudit
- Owner: Janani1727
- Created: 2024-07-03T06:20:40.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-07-07T18:45:26.000Z (7 months ago)
- Last Synced: 2024-07-31T10:36:18.870Z (6 months ago)
- Language: JavaScript
- Size: 1.92 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Team Name: Cipher
## Team Members:
- Rahul Kumar Singh
- Ashmit Yadav
- Rakesh Roshan
- Janani Jayaraman
Deployed Link:-https://code-audit-ai-git-master-rahul-kumar-singhs-projects.vercel.app/
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Screenshot](#screenshot)
## Introduction
**CodeAudit** is a hackathon project developed by a team Cipher of four members. It is a web application designed to help developers improve their code by providing suggestions on optimization, naming standards, and code quality. The tool supports multiple programming languages and uses the latest AI models to generate insightful feedback.
## Features
- **Multi-language Support:** Works with JavaScript, Python, Java, C#, C++, Go, Ruby, and TypeScript.
- **Inline Comments:** Provides inline comments to highlight areas of improvement.
- **Code Editor:** Integrated Monaco Editor with a custom black theme for an enhanced coding experience.
- **AI-Powered Feedback:** Utilizes AI to analyze and suggest improvements for your code.
## Technologies Used
- **Frontend:**
- React
- Chakra UI
- Monaco Editor
- **Authentication:**
- Firebase
- **AI:**
- Google Gemini API
## Installation
Follow these steps to set up the project locally:
1. Clone the repository:
```bash
git clone https://github.com/Janani1727/codeaudit.git
cd codeaudit
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm start
```
4. Open your browser and navigate to `http://localhost:3000`.
## Usage
1. Enter your code in the integrated editor.
2. Select the programming language from the dropdown.
3. Type your question or specific aspect of the code you want
## Screenshot
Home page screenshot
Dashboard screenshot
