{"id":18048650,"url":"https://github.com/pyrech/rag-ai-documentation","last_synced_at":"2025-07-12T09:39:57.534Z","repository":{"id":259205207,"uuid":"851271017","full_name":"pyrech/rag-ai-documentation","owner":"pyrech","description":"Just a POC","archived":false,"fork":false,"pushed_at":"2024-10-28T09:43:02.000Z","size":279,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T10:52:34.707Z","etag":null,"topics":["ia","proof-of-concept","retrieval-augmented-generation"],"latest_commit_sha":null,"homepage":"https://jolicode.com/blog/construire-un-chatbot-specialise-sur-vos-donnees-grace-a-lia-generative-et-php","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyrech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-09-02T19:03:33.000Z","updated_at":"2025-03-19T04:01:10.000Z","dependencies_parsed_at":"2024-10-28T11:16:32.339Z","dependency_job_id":"0b5afadc-d97b-42f7-9d44-663d95bd5747","html_url":"https://github.com/pyrech/rag-ai-documentation","commit_stats":null,"previous_names":["pyrech/rag-ai-documentation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrech%2Frag-ai-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrech%2Frag-ai-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrech%2Frag-ai-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrech%2Frag-ai-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyrech","download_url":"https://codeload.github.com/pyrech/rag-ai-documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248197984,"owners_count":21063623,"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":["ia","proof-of-concept","retrieval-augmented-generation"],"created_at":"2024-10-30T20:14:09.093Z","updated_at":"2025-04-10T09:51:54.717Z","avatar_url":"https://github.com/pyrech.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# RAG AI documentation\n\nThis project is a proof of concept of a RAG-based chatbot that can answer questions about a website's documentation.\n\n![Screenshot of the POC](assets/poc.png)\n\nThis project has been created as a support for this blog post: https://jolicode.com/blog/construire-un-chatbot-specialise-sur-vos-donnees-grace-a-lia-generative-et-php\n\n## TLDR\n\nCreate a `application/.env.local` file and fill it with the following env vars:\n- `OPENAI_API_KEY` with your OpenAI API key\n- `DOCUMENTATION_URL` with the URL of the website you want to crawl and analyze\n\n```shell\ncastor start\ncastor builder\nbin/console app:crawl\n```\n\n## Running the application locally\n\n### Requirements\n\nA Docker environment is provided and requires you to have these tools available:\n\n* Docker\n* Bash\n* [Castor](https://github.com/jolicode/castor#installation)\n\n#### Castor\n\nOnce castor is installed, in order to improve your usage of castor scripts, you\ncan install console autocompletion script.\n\nIf you are using bash:\n\n```bash\ncastor completion | sudo tee /etc/bash_completion.d/castor\n```\n\nIf you are using something else, please refer to your shell documentation. You\nmay need to use `castor completion \u003e /to/somewhere`.\n\nCastor supports completion for `bash`, `zsh` \u0026 `fish` shells.\n\n### Docker environment\n\nThe Docker infrastructure provides a web stack with:\n- NGINX\n- PostgreSQL\n- PHP\n- Traefik\n- A container with some tooling:\n    - Composer\n    - Node\n    - Yarn / NPM\n\n### Domain configuration (first time only)\n\nBefore running the application for the first time, ensure your domain names\npoint the IP of your Docker daemon by editing your `/etc/hosts` file.\n\nThis IP is probably `127.0.0.1` unless you run Docker in a special VM (like docker-machine for example).\n\n\u003e [!NOTE]\n\u003e The router binds port 80 and 443, that's why it will work with `127.0.0.1`\n\n```\necho '127.0.0.1 \u003cyour hostnames\u003e' | sudo tee -a /etc/hosts\n```\n\n### Starting the stack\n\nLaunch the stack by running this command:\n\n```bash\ncastor start\n```\n\n\u003e [!NOTE]\n\u003e the first start of the stack should take a few minutes.\n\nThe site is now accessible at the hostnames your have configured over HTTPS\n(you may need to accept self-signed SSL certificate if you do not have mkcert\ninstalled on your computer - see below).\n\n### SSL certificates\n\nHTTPS is supported out of the box. SSL certificates are not versioned and will\nbe generated the first time you start the infrastructure (`castor start`) or if\nyou run `castor docker:generate-certificates`.\n\nIf you have `mkcert` installed on your computer, it will be used to generate\nlocally trusted certificates. See [`mkcert` documentation](https://github.com/FiloSottile/mkcert#installation)\nto understand how to install it. Do not forget to install CA root from mkcert\nby running `mkcert -install`.\n\nIf you don't have `mkcert`, then self-signed certificates will instead be\ngenerated with openssl. You can configure [infrastructure/docker/services/router/openssl.cnf](infrastructure/docker/services/router/openssl.cnf)\nto tweak certificates.\n\nYou can run `castor docker:generate-certificates --force` to recreate new certificates\nif some were already generated. Remember to restart the infrastructure to make\nuse of the new certificates with `castor up` or `castor start`.\n\n### Builder\n\nHaving some composer, yarn or other modifications to make on the project?\nStart the builder which will give you access to a container with all these\ntools available:\n\n```bash\ncastor builder\n```\n\n### Other tasks\n\nCheckout `castor` to have the list of available tasks.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyrech%2Frag-ai-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyrech%2Frag-ai-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyrech%2Frag-ai-documentation/lists"}