Developer Resources

Get started with A.R.E.N. development and contribute to the project

Technology Stack

Python

Core programming language

PyQt6

GUI framework

scikit-learn

Machine learning library

SQLite

Local database

Installation Guide

Clone the Repository

git clone https://github.com/your-username/aren.git
cd aren

Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install Dependencies

pip install -r requirements.txt

Run the Application

python src/main.py

Contribution Guidelines

  • Code Style

    Follow PEP 8 guidelines and use type hints for better code maintainability.

  • Testing

    Write unit tests for new features and ensure all tests pass before submitting a PR.

  • Documentation

    Update documentation for any new features or changes to existing functionality.

  • Security

    Maintain the offline-first approach and avoid introducing external dependencies.