{"id":25439021,"url":"https://github.com/ches-ctrl/ai_engine","last_synced_at":"2025-05-15T09:34:55.554Z","repository":{"id":277685180,"uuid":"933196482","full_name":"Ches-ctrl/ai_engine","owner":"Ches-ctrl","description":"Multi-agent system for AI Engine Hack","archived":false,"fork":false,"pushed_at":"2025-02-15T11:54:55.000Z","size":0,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T12:29:22.651Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ches-ctrl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-15T11:39:59.000Z","updated_at":"2025-02-15T11:54:59.000Z","dependencies_parsed_at":"2025-02-15T12:39:32.291Z","dependency_job_id":null,"html_url":"https://github.com/Ches-ctrl/ai_engine","commit_stats":null,"previous_names":["ches-ctrl/ai_engine"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ches-ctrl%2Fai_engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ches-ctrl%2Fai_engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ches-ctrl%2Fai_engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ches-ctrl%2Fai_engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ches-ctrl","download_url":"https://codeload.github.com/Ches-ctrl/ai_engine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254313643,"owners_count":22050076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-17T10:17:16.310Z","updated_at":"2025-05-15T09:34:55.515Z","avatar_url":"https://github.com/Ches-ctrl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\nMulti-agent system for AI Engine Hack\n\n# Technologies Used\nThroughout these docs, Terminal commands are provided for Unix shells (i.e. MacOS, Linux).\n\n## Frontend\n\n## Backend\n- Python 3.11\n- Flask\n- Pydantic\n- pytest\n\u003cbr\u003e\u003cbr\u003e\n\n# Running backend\n\n## Setup\n1. Check you have Python 3.11 installed, a specific version number should be returned in the Terminal (e.g. `Python 3.11.11`).\n    ```bash\n    python3.11 --version\n    ```\n\u003cbr\u003e\n\n2. Navigate to `backend` folder and create an `.env.local` file (copying `.env.example`).\n    ```bash\n    cd backend \u0026\u0026 cp .env.example .env.local\n    ```\n\u003cbr\u003e\n\n## Running backend locally\nThe backend can be run:\n* within a virtual environment or a docker container\n* in development or production mode\n\n\u003cbr\u003e\n\nFrom the backend folder, there are 4 ways to run the backend:\n| **environment** | **mode** | **command** |\n|-----------------|----------|-------------|\n| virtual env | dev | `./boot.sh venv dev` |\n| virtual env | prod | `./boot.sh venv prod` |\n| docker | dev | `./boot.sh docker dev` |\n| docker | prod | `./boot.sh docker prod` |  \n\nBackend served at [http://localhost:8080](http://localhost:8080) - only route available is 'Hello, World!' smoke test on index route (`/`).\n\u003cbr\u003e\u003cbr\u003e\n\n# Testing\n\n## Running backend tests\n1. Set up backend following ([setup](#setup)) instructions above.\n2. Once in `backend` folder, execute `./test.sh` from Terminal\n\n    | **testing mode** |  **command** |\n    |------------------|--------------|\n    | running tests normally |  `./test.sh` |\n    | running tests with coverage report |  `./test.sh coverage` |\n    | running tests with detailed output |  `./test.sh verbose` |\n\u003cbr\u003e\u003cbr\u003e\n\n# Deployment\n## Requirements for running backend locally\n* The following files are used for running the backend locally using a virtual environment (in `dev` or `prod` modes):\n    * [boot.sh](/backend/boot.sh)\n    * [config.py](/backend/config.py)\n    * env files (`.env.local` / `.env.prod`)\n\n* The following files are used for running the backend locally using a docker container (in `dev` and `prod` modes):\n    * [config.py](/backend/config.py)\n    * env files (`.env.local`, `.env.prod`)\n    * docker compose files (dev: [docker-compose.yml](/backend/docker-compose.yml) / prod: [docker-compose.prod.yml](/backend/docker-compose.yml))\n    * dockerfile ([Dockerfile.dev](/backend/Dockerfile.dev) / [Dockerfile.prod](/backend/Dockerfile.prod))\n\nNOTE: [boot.sh](/backend/boot.sh) not required for running backend using docker, because we only use the `docker compose` commands at the very end of the file.\n\u003cbr\u003e\u003cbr\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fches-ctrl%2Fai_engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fches-ctrl%2Fai_engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fches-ctrl%2Fai_engine/lists"}