1. Clone the repository into your device:

   git clone git@github.com:0xRickey/DevSoc-Hackathon-24T3.git

2. Install python virtual environments and pip if you don't have it already.

   sudo apt install python3.10-venv

   sudo apt install pip

   Pip is Python's package manager and we will use a virtual environment to develop in to make it so that there will be no package conflicts between our repository and your device's global packages.

3. Set up python virtual environment

   python3 -m venv .venv

4. Start a new virtual environment session.

   source .venv/bin/activate

   After running the following command, your terminal will be appended with "(.venv)" to indicate that you have successfully created a new virtual environment. For example:

   (.venv) user@device_name:~/path/to/repo

5. Install the required packages for your virtual environment with the command:

   pip install -r requirements.txt

   If the requests_html library installation is giving you issues. You may have to install it separately with:

   pip install requests_html
   

   This library also depends on another library that is a bit finnicky and also requires its own installation command:

   pip install lxml-html-clean
   

   Do note that the first time you run a script that uses requests_html it may install Chromium into your local development environment.

If you want to get the frontend up and see what the code is doing, you should first run npm install to get all the required node modules and then after everything is done installing you can run npm start to start a localhost server for the frontend.