pc-builder 1.0.5

A CLI application for building and managing PC configurations.

PC Builder

Overview

The PC Builder is an application designed to help users plan and configure their ideal personal computer setup. It allows users to select components based on their needs, budget, and preferences, providing recommendations and compatibility checks.

Team Members

• Domantas Petkevičius - Back-End Developer, Team Leader
• Dagnis Matulis - Back-End Developer
• Juozas Krukauskas - Front-End Developer
• Simona Vytytė - Front-End Developer

Project Description

The PC Builder application provides an intuitive interface for users to:

• Browse and select various computer components (CPU, GPU, RAM, etc.)
• Add and remove parts from their personal build and display the current configurations.
• Get compatibility checks for selected components.
• View estimated costs based on selected parts.

Technologies Used

• Programming Language: python
• Frameworks: click for CLI interface
• Testing: pytest and unittest for unit and integration testing
• Build Tools: tox for testing automation and building, PyInstaller for creating executable files

Infrastructure Management

The project uses Git for version control and GitHub for repository hosting. Continuous integration and testing are set up using tox, which automates the testing and build processes.

Installing the PC Builder Package

• You can easily install the PC Builder package via pip from PyPI (if available):

  pip install pc-builder
  

• Once installed, you can use the pcbuilder command in your terminal to run the application:

  pcbuilder
  

Building and Running the Application from source

This guide provides instructions for users to set up the PC Builder project, run tests, and build the application from source.

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Python 3.7 or later: Download and install Python from python.org.
• pip: This usually comes pre-installed with Python. You can check if you have pip installed by running:

  pip --version
  

Building and Running the Application Locally

• Clone the repository https://github.com/mif-it-se-2024/group-project-pc-builders

• Navigate to the Project Directory

  cd pc_builder
  

• Create a Virtual Environment (Optional but Recommended)

  Windows:

  python -m venv venv
  venv\Scripts\activate
  

  Linux:

  python3 -m venv venv
  source venv/bin/activate
  

• Install Project Dependencies

  pip install -r requirements.txt
  

• Run tests and build the application

  tox
  

• Launch the application

  cd dist
  

  pcbuilder.exe ( Windows ) or ./pcbuilder ( Linux )