Skip to content

docs: add devcontainer guide #7

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.

Sign up for GitHub

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

Open
Menefail wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add devcontainer guide #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .devcontainer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Dev Container

This folder contains configuration for developing quickfix inside a containerized environment. It includes:

- `Dockerfile.dev` – defines the base image and toolchain for the Go FIX engine.
- `devcontainer.json` – settings used by editors like Visual Studio Code to launch the dev container.
- `docker-compose.yml` – sample compose file for bringing up a dependent database stack.

To use the development container with VS Code:

1. Install the "Remote – Containers" extension.
2. Open the repository in VS Code.
3. Use the command palette and select **Remote-Containers: Open Folder in Container...**.

The dev container will automatically build the image and set up everything you need to hack on the project.