Getting Started

Here you will find instructions for installing and setting up EAK-Copilot.

Prerequisites

Before starting, ensure you have the following software installed on your computer:

• Git: Needed for source code management. Install from here.

• Docker: Required for running containers. Install from here.

• Docker Compose: Necessary for managing multi-container Docker applications. Install from here.

Linux users may need to prepend sudo to Docker commands depending on their Docker configuration.

Installation

1. Clone the Repository

   Begin by cloning the EAK-Copilot repository to your local machine to get the necessary project files.

   git clone https://github.com/CdC-SI/eak-copilot.git
   cd eak-copilot
   

2. Setting Up Environment Variables

   To use EAK-Copilot, you need to set up some environment variables. Copy the .env.example file to a new file named .env and fill in the appropriate values:

   cp .env.example .env
   

3. Build Docker Images

   Build the Docker images using the Docker Compose configuration. This step compiles and launches your Docker environment.

   docker-compose up --build -d
   

4. Verifying the Installation

   Check the status of the containers to confirm everything is running as expected:

   docker-compose ps
   

After the containers are successfully started, navigate to http://localhost:4200 in your web browser to access the EAK-Copilot.