2025-01-10 12:58:14 +00:00
|
|
|
# Query Orchestration
|
2024-12-19 11:38:57 +00:00
|
|
|
|
2025-01-10 12:58:14 +00:00
|
|
|
This repository contains the DoczyAI code.
|
2024-12-19 11:38:57 +00:00
|
|
|
|
|
|
|
|
Using the following project as a baseline: https://github.com/golang-standards/project-layout.
|
|
|
|
|
|
2025-01-10 12:58:14 +00:00
|
|
|
## Installation and Usage
|
2024-12-19 11:38:57 +00:00
|
|
|
|
2025-01-10 12:58:14 +00:00
|
|
|
- Install devbox: `https://www.jetify.com/docs/devbox/installing_devbox`
|
|
|
|
|
- Ubuntu/MacOS: `curl -fsSL https://get.jetify.com/devbox | bash`
|
2025-01-14 13:28:25 +00:00
|
|
|
- Run `devbox run init` to create init dependencies
|
2025-01-10 12:58:14 +00:00
|
|
|
- Run `devbox shell` to enter the environment
|
|
|
|
|
- Run `task deps:download` to download code dependencies
|
|
|
|
|
- (IF NECESSARY) Ensure user in docker group and docker group is in sudo group
|
2024-12-19 11:38:57 +00:00
|
|
|
```
|
|
|
|
|
sudo groupadd docker
|
|
|
|
|
sudo usermod -aG docker $USER
|
|
|
|
|
```
|
2025-01-10 12:58:14 +00:00
|
|
|
|
|
|
|
|
To find new packages: `https://search.nixos.org/packages`
|
|
|
|
|
|
2025-01-14 17:28:26 +00:00
|
|
|
For regular usage, please use `task` scripts in order run the most appropriate configuration.
|
|
|
|
|
|
|
|
|
|
# Environment Variables
|
|
|
|
|
|
|
|
|
|
When using environment variables, there is a hiearchy that will be respected. (First will override the next)
|
|
|
|
|
|
|
|
|
|
1. Within the devbox.json file, a variable added to "env"
|
|
|
|
|
2. Within the devbox.json file, a variable exported in "init_hook"
|
|
|
|
|
3. A variable added to .env
|
