Skip to content

IDEA-Research-Group/alba-assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ALBA-ASSISTANT: Application to improve Security and Sustainable-awareness in Smart Home

Alba-Assistant enables users to model their smart home devices and their connections through a graph within the application. Additionally, it retrieves information from various external APIs regarding vulnerabilities, risks, and sustainability values linked to the devices added by the user. Once the information is processed, metrics and graphs are generated and presented to users through dashboards offering different degrees of details.

Internally, it consists of a Django-based backend that supplies information to a React application via REST API.

Installation

  1. Clone the repository:
git clone https://github.com/IDEA-Research-Group/alba-assistant.git
cd alba-assistant
  1. Create a virtual environment for the backend:
python -m venv venv
  1. Activate the virtual environment:
  • On Windows:

    .\venv\Scripts\activate
    
  • On macOS/Linux:

    source venv/bin/activate
    

Backend Setup

  1. Run migrations:
python manage.py migrate
  1. Start the server:
python manage.py runserver

The backend will be available at https://localhost:8000.

Rest-API: https://localhost:8000/vulnet/api/v1/

Frontend Setup

  1. Navigate to the frontend directory:
cd vulnet_frontend
  1. Install frontend dependencies:
npm install
  1. Start the React application:
 npm start

The frontend will be available at https://localhost:5173.

License

This project is under the GNU General Public License (GPL) License.