Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Add Docker, Docker Compose, System Requirements, and CI/CD Pipeline for Container Publishing #11

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

charlesvien
Copy link

@charlesvien charlesvien commented Dec 22, 2024

This PR enhances the project by introducing Docker and Docker Compose support, simplifying the process of building and running the project in a containerized environment. Key updates include:

  • A Dockerfile to streamline the setup process.
  • Docker Compose support for easier command execution.
  • README updates with Docker build/run instructions and system requirements.
  • Support for running both the Hedge Fund system and the Backtester scripts using Docker.
  • A GitHub CI/CD pipeline to build and publish the Docker container on each push to the main branch or tagged version.

You can verify the successful publishing of the image via the included CI/CD pipeline on my fork here:

The Docker setup and pipeline were tested on macOS and Windows to ensure cross-platform compatibility.

NOTE: The docker compose setup ghcr image is set to to this project's repostory, until this merges then there will be no image available on ghcr to pull from so you'll get an error. I've tested this by using my fork's ghcr from the successful CI/CD publish.

@arsaboo
Copy link
Contributor

arsaboo commented Dec 23, 2024

@charlesvien This is great already. However, a docker-compose implementation would be great (in a separate PR maybe).

@accforgithubtest
Copy link

I am looking forward to this PR getting merged.
I hope a few related things to be added as well to make this easy to use -

  1. An official docker image on ghcr / dockerhub (so end users dont have to build the project)
  2. Pls add examples on how to use via docker compose to the readme files.
  3. Would be good to know what are the minimum system requirements to run this. My understanding is that there are no local LLM's involved, and this project is managing the workflows between the datasource (financial dataset) and the LLM (open ai). So I assume this should be runnable reasonably well on a laptop, but would be good to know what the project's hardware minimum recommendations are.

@charlesvien charlesvien changed the title feature: Add Docker Support and Instructions to README feature: Add Docker, Docker Compose, System Requirements, and CI/CD Pipeline for Container Publishing Dec 24, 2024
@charlesvien charlesvien force-pushed the main branch 3 times, most recently from c72581f to ed7cca4 Compare December 24, 2024 02:11
@charlesvien
Copy link
Author

I am looking forward to this PR getting merged. I hope a few related things to be added as well to make this easy to use -

  1. An official docker image on ghcr / dockerhub (so end users dont have to build the project)
  2. Pls add examples on how to use via docker compose to the readme files.
  3. Would be good to know what are the minimum system requirements to run this. My understanding is that there are no local LLM's involved, and this project is managing the workflows between the datasource (financial dataset) and the LLM (open ai). So I assume this should be runnable reasonably well on a laptop, but would be good to know what the project's hardware minimum recommendations are.

Should be addressed in the latest commit 👍

@accforgithubtest
Copy link

Any idea when this pr might get merged ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants