Skip to content

Add Docker Compose Setup and Improve Local Development Documentation#55

Open
StefanRoesch wants to merge 1 commit intomainfrom
feature/add-docker-compose-and-readme-update
Open

Add Docker Compose Setup and Improve Local Development Documentation#55
StefanRoesch wants to merge 1 commit intomainfrom
feature/add-docker-compose-and-readme-update

Conversation

@StefanRoesch
Copy link
Contributor

Add Docker Compose Setup and Improve Local Development Documentation

Summary

This PR introduces a docker-compose.yml file and updates the README.md to make local development setup easier and more accessible. It also clarifies the steps performed by the mix setup alias.


Changes

  • Added docker-compose.yml:

    • Provides services for Postgres (with pgvector) and Ollama.
    • Includes persistent volumes and optional GPU support (commented).
    • Automates pulling required Ollama models for convenience.
  • Updated README.md:

    • Added a section explaining how to use Docker Compose for local development.
    • Clarified that Docker must be installed to use this method.
    • Detailed the steps performed by the mix setup alias for better onboarding.
    • Improved overall clarity for new contributors.

Motivation

  • Simplifies onboarding for new contributors and users.
  • Reduces the need for manual installation of dependencies.
  • Makes it easier to get a working development environment with a single command.

How to Test

  1. Ensure you have Docker installed.
  2. Run:
    docker compose up -d
  3. Follow the updated README instructions to start the Phoenix server and verify that both Postgres and Ollama are running as expected.

Notes

  • The Docker Compose setup pulls required Ollama models automatically for convenience.
  • GPU support is available by uncommenting the relevant lines in the compose file.

Feedback and suggestions are welcome!

…ompose.yml

- Added instructions to the README for using Docker Compose to start Postgres (with pgvector) and Ollama for local development.
- Clarified that Docker must be installed to use Docker Compose.
- Added a docker-compose.yml file to simplify local setup of required services.
- Explained the `mix setup` alias steps in the README for better onboarding.
@StefanRoesch StefanRoesch requested a review from xhr15 May 12, 2025 07:01
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.

1 participant