System Requirements

💻 System Requirements

This page describes the software, tools, and environment required to run and develop NexaWork locally.

🐍 Backend

NexaWork's backend is built with Python and requires:

• Python: 3.11 or newer
• FastAPI: Web API framework
• SQLAlchemy: Database ORM
• Alembic: Database migrations
• Pydantic: Data validation and schemas

🗄️ Database

• PostgreSQL: Required for persistent application data.
• A local PostgreSQL installation or a PostgreSQL instance accessible from the development environment is required.

🧪 Testing

NexaWork uses automated tests to verify application behavior and maintain code quality.

• pytest: Test framework
• Tests should be run from the project's virtual environment.

🔧 Development Tools

The following tools are recommended:

• Git: Version control
• VS Code: Recommended code editor
• Terminal: Bash, Zsh, or another compatible shell
• Virtual environment: Python venv for isolated dependencies

🖥️ Supported Development Environments

NexaWork is intended to run in common development environments that support Python and PostgreSQL, including:

• Linux
• macOS
• Windows with a suitable Python/PostgreSQL development environment

📦 Project Dependencies

Install the project's Python dependencies from the repository's dependency file rather than installing individual packages manually.

Refer to the Installation Guide for the complete setup process.

---

Note: Requirements may change as NexaWork develops. This page should be updated whenever a major technology or infrastructure requirement is introduced.