aidecentralized / sonar

SONAR - Self-Organizing Network of Aggregated Representations
MIT License
7 stars 27 forks source link

Dockerized setup for sonar #19

Open hardlyhuman opened 1 month ago

hardlyhuman commented 1 month ago

This PR adds a Dockerfile for setting up the project environment using Docker as proposed in #12 and updates the README.md with instructions for building and running the Docker container. The goal is to provide a consistent development environment for all contributors.

Changes Made

  1. Dockerfile Added:

    • Created a Dockerfile to set up the project with the necessary dependencies.
    • Utilizes Ubuntu Latest LTS as the base image.
    • Installs required packages including Python 3.11 and related tools.
    • Sets up a virtual environment and installs dependencies from requirements.txt.
  2. docker_run.sh Script Added:

    • A script to simplify running the Docker container.
    • Ensures volume mounting, working directory setup, and interactive mode for ease of use.
  3. README.md Updated:

    • Added detailed instructions on how to build and run the Docker container.
    • Included prerequisites and step-by-step guidance for cloning the repository, building the Docker image, and running the container.
    • Added a note to update the image name in the docker_run.sh script if a different name is used during the build process.
    • Instructions on running the script using both ./ and bash commands.

Notes for Reviewers

How to Test

  1. Clone the repository.
  2. Build the Docker image using the instructions in the README.md.
  3. Run the Docker container using the provided docker_run.sh script.
  4. Verify that the container starts correctly and the environment is set up as expected.