Welcome to CodeCompanion.AI, your personal coding assistant that helps you translate natural language instructions into code. This document will guide you through setting up the application, understanding its structure, and contributing to its development.
To start using CodeCompanion desktop app, simply download it:
Or if you want to contribute or make changes to the code, please follow the instructions below:
Clone the repository.
Navigate to the project directory.
Run npm install to install dependencies.
The application has a dependency on node-pty. To install it, follow the instructions provided here.
Start the application with npm start or npm run debug for development mode.
Here's an overview of the project's directory structure:
build/: Production-ready compiled files.app/: Core application logic and functionality.styles/: Styling and appearance of the application.index.html: Main entry point for the UI.main.js: Electron main process script.preload.js: Pre-rendering script for the renderer process.renderer.js: Electron renderer process script.scripts/: Utility and build scripts.Contributions are welcome! Please refer to CONTRIBUTING.md for contribution guidelines.
CodeCompanion.AI is open-source software licensed under the MIT License. See LICENSE.md for more information.
Thank you for using CodeCompanion.AI. Happy coding!