Hi there, I'm Falanger

Comp@Tibility

Build your own PC set-up!
View Demo
You may need to wait up to one minute to wake the host up (render.com)
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

The application allows users to check the compatibility of PC components assembled within the app.
Additionally, they can monitor the estimated wattage of the parts combined together.

Compatibility Requirements Implemented

1. CPU & Motherboard
   • Sockets must be the same
2. Motherboard & Computer Case
   • Form Factor of the motherboard must be supported by Computer Case (EATX, ATX, Micro-ATX, Mini-ITX)
3. Motherboard & Memory
   • Memory capacity must not exceed the maximum memory supported by the motherboard
   • Memory number of sticks must be smaller than the number of motherboard memory slots
   • Memory type must be supported by motherboard (DDR3, DDR4, DDR5)
4. CPU Cooler & Computer Case
   • The CPU cooler’s dimensions must fit within the computer case
5. GPU & Power Supply
   • The power supply must provide more wattage than the GPU's recommended requirement
6. GPU & Computer Case
   • GPU's size must fit within the computer case
7. GPU & Motherboard
   • GPU and motherboard interface type must be the same
   • GPU interface version must be supported by motherboard
8. Storage & Motherboard
   • Storage type must be supported by motherboard

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

1. Node.js
   To check if Node.js is already installed on your system, run:

node -v  

If you need to install or manage Node.js versions more conveniently, it’s highly recommended to use NVM (Node Version Manager).

• NVM for Windows: https://github.com/coreybutler/nvm-windows

• NVM for Mac/Linux: https://github.com/nvm-sh/nvm.git

Once NVM is installed, you can easily install and use the desired Node.js version. For example:

nvm install 22.12.0
nvm use 22.12.0

If you prefer not to use NVM, you can install Node.js manually from https://nodejs.org.

2. MySql You need to install MySql engine and MySqlWorkbench on your machine from:

• https://www.mysql.com/

Installation

1. Clone the repository:
   Run the following commands to clone the repository and navigate to the project directory:

   git clone https://github.com/Falanger-debug/Comp-Atibility
   cd Comp-Atibility
   

2. Get the initial database:
   • Download the file called DatabaseDumpWithStructureAndData from the data folder
   • Open MySqlWorkbench and under Server select Data Import
   • Select Import from Self-Contained File and define the path to the previously downloaded file.
   • Select Default Schema to be Imported To in the center and Dump Structure and Data at the bottom, and start your import.
3. Create .env file in Comp-Atibility folder with variables such as:
   • PORT
   • MYSQL_PORT
   • MYSQL_HOST
   • MYSQL_USER
   • MYSQL_PASSWORD
   • MYSQL_DATABASE
4. Install dependencies:
   Install all the required packages by running:

npm install

5. Run the application:
   Start the application using the following command:

npm run dev

Once the application is running, open your browser and visit:
http://localhost:8000 (if you haven't defined different PORT in .env file)

(back to top)

Usage

(back to top)

Contributing

Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch

git checkout -b feature/AmazingFeature

3. Commit your Changes

   git commit -m "Add some AmazingFeature"
   

4. Push to the Branch

git push origin feature/AmazingFeature

5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)