Files
query-orchestration/README.md
T
Michael McGuinness 6e5c7aedc8 Merged in feature/devbox (pull request #11)
Add Devbox

* adddevbox

* cleanupdockerfile

* testscripts
2025-01-10 12:58:14 +00:00

23 lines
854 B
Markdown

# Query Orchestration
This repository contains the DoczyAI code.
Using the following project as a baseline: https://github.com/golang-standards/project-layout.
## Installation and Usage
- Install devbox: `https://www.jetify.com/docs/devbox/installing_devbox`
- Ubuntu/MacOS: `curl -fsSL https://get.jetify.com/devbox | bash`
- Run `devbox shell` to enter the environment
- Create `.env` file to add environment variables
- Run `direnv allow` to ensure environment variables are populated
- Run `task deps:download` to download code dependencies
- (IF NECESSARY) Ensure user in docker group and docker group is in sudo group
```
sudo groupadd docker
sudo usermod -aG docker $USER
```
To find new packages: `https://search.nixos.org/packages`
For regular usage, please use `task` scripts in order run the most appropriate configuration.