CodeCompanion.AI

Welcome to the CodeCompanion.AI application! This document provides you with the necessary information to get started with the application, contribute to its development, and understand its structure.

Getting Started

To get the application up and running on your local machine, follow these steps:

1. Clone the repository to your local machine.
2. Navigate to the cloned directory.
3. Run npm install to install all the required dependencies.
4. Use npm run start to start the application.
5. To start the application with the developer console open, use npm run debug.

Project Structure

The project is structured as follows:

• build/: Contains compiled files ready for production.
• js/: Contains JavaScript files for the application's logic.
• styles/: Contains CSS files for styling the application.
• index.html: The entry point for the application's user interface.
• main.js: The main process of the Electron application.
• preload.js: Script that runs before the renderer process.
• renderer.js: The renderer process of the Electron application.
• scripts/: Contains various scripts for development and building the application.

Contributing

We welcome contributions from the community! Please read the CONTRIBUTING.md file for guidelines on how to make contributions.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

We hope you enjoy using CodeCompanion.AI and we look forward to seeing your contributions to the project!