You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-8Lines changed: 4 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,6 @@ Rocket Chatter App is an open-source AI-powered assistant designed to help devel
18
18
19
19
-**Assess Code Importance**: The app can evaluate the criticality and centrality of code entities, providing insights into their impact and dependencies, which is crucial for tasks like refactoring or introducing new features. The app will generate scores for criticality (how many other parts of the code depend on this entity), centrality (how connected this entity is to other parts), and overall importance, helping developers prioritize their efforts.
20
20
21
-
-**Enforce Style Guides**: The app can automatically check the codebase against predefined style guides and coding standards, ensuring code quality, consistency, and readability across the project. Developers can provide code snippets, and the app will suggest improvements based on the project's style guide, promoting best practices and maintainability.
22
-
23
21
-**Suggest Improvements**: The app can analyze code snippets and offer targeted refactoring suggestions, such as renaming variables, extracting code into reusable functions, removing dead code, and optimizing performance. These suggestions will help developers write cleaner, more efficient, and maintainable code while adhering to the project's coding standards.
24
22
25
23
### Accessibility and Collaboration
@@ -49,21 +47,19 @@ Rocket Chatter App is an open-source AI-powered assistant designed to help devel
49
47
50
48
### Usage
51
49
52
-
Once the application is running, you can access the Rocket Chatter App through the Rocket.Chat interface. The app provides various slash commands (e.g., `/rcc-ask`, `/rcc-diagram`, `/rcc-document`) that you can use to interact with the assistant.
50
+
Once the application is running, you can access the Rocket Chatter App through the Rocket.Chat interface. The app provides various slash commands (e.g., `/rcc-askcode`, `/rcc-diagram`, `/rcc-document`) that you can use to interact with the assistant.
53
51
54
52
## Architecture
55
53
56
54
The Rocket Chatter App follows a modular architecture with the following main components:
57
55
58
56
1.**Rocket Chat Application**: A user-friendly interface for developers to interact with the system, enabling them to ask questions, request diagrams, and access documentation directly within the Rocket.Chat environment. The application is built using the Rocket.Chat App Engine SDK and is deployed as a Rocket.Chat App. 
59
57
2.**Ingestion Server**: Responsible for parsing the Rocket.Chat codebase, extracting relevant information, and storing it in the Neo4j graph database. It utilizes compiler APIs like `ts-morph` and `jscodeshift` to handle TypeScript and JavaScript code constructs. The ingestion process involves chunking the codebase, generating embeddings for code entities, and establishing relationships between them in the graph database. 
60
-
3.**Application Server**: A middleware component built with Express.js that serves as a bridge between the database and the client application. It handles requests from the Rocket Chat App, queries the Neo4j database using cosine similarity-based searches, and generates responses using Language Models (LMs). The server employs a Retrieval Augmented Generation (RAG) pipeline to provide contextual and accurate information to developers. 
61
-
62
58
63
59
### Development Environment Setup
64
60
65
-
1. Fork the repository and clone your fork: `git clone https://github.com/your-username/rocket-chatter-app.git`
66
-
2. Navigate to the project directory: `cd rocket-chatter-app`
67
-
3. Install dependencies: `npm install`
61
+
1. Fork the repository and clone your fork: `git clone https://github.com/your-username/Apps.AI.Codebase.Assistant.git`
62
+
2. Navigate to the project directory: `cd Apps.AI.Codebase.Assistant`
63
+
3. Install dependencies: `bun install`
68
64
4. Set up the required environment variables (e.g., database credentials, API keys) by creating a `.env` file based on the provided `.env.example` file.
0 commit comments