{"id":27962079,"url":"https://github.com/tmeftah/aora","last_synced_at":"2026-03-04T03:02:20.161Z","repository":{"id":250561054,"uuid":"822488399","full_name":"tmeftah/Aora","owner":"tmeftah","description":"Aora is an application designed to leverage AI for advanced document handling and natural language processing. This repository contains both backend and frontend components to get the application up and running.","archived":false,"fork":false,"pushed_at":"2025-03-11T17:59:11.000Z","size":510,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-05-07T19:14:12.318Z","etag":null,"topics":["documentation","fastapi","langchain","llm","ollama","platform","rag"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmeftah.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,"zenodo":null}},"created_at":"2024-07-01T08:49:32.000Z","updated_at":"2025-03-09T16:53:14.000Z","dependencies_parsed_at":"2024-08-28T06:24:28.202Z","dependency_job_id":"c8f3709e-92a3-4b82-8fcf-985b3ddc96b1","html_url":"https://github.com/tmeftah/Aora","commit_stats":null,"previous_names":["tmeftah/llm","tmeftah/aora"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/tmeftah/Aora","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmeftah%2FAora","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmeftah%2FAora/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmeftah%2FAora/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmeftah%2FAora/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmeftah","download_url":"https://codeload.github.com/tmeftah/Aora/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmeftah%2FAora/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30070479,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T01:03:42.280Z","status":"online","status_checked_at":"2026-03-04T02:00:07.464Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","fastapi","langchain","llm","ollama","platform","rag"],"created_at":"2025-05-07T19:14:08.532Z","updated_at":"2026-03-04T03:02:20.144Z","avatar_url":"https://github.com/tmeftah.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aora | Ahead Of Rest, Always.\n\n## 📜 About\n\nAora is an application designed to leverage AI for advanced document handling and natural language processing. This repository contains both backend and frontend components to get the application up and running.\n\n![Aora LogIn](./images/aora.PNG)\n\n## 📟 Recommended Setup\n\nHighly recommended:\n\n- [VSCode](https://code.visualstudio.com/)\n- [Python](https://www.python.org/downloads/)\n- [Docker](https://www.docker.com/get-started)\n- [Node](https://nodejs.org/en/download/package-manager)\n- [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) by Vue: Inter alia code formatter used for Vue.\n  - 🛑 Attention: Disable Vetur!\n  - Remark: The extension is also called **Volar**.\n- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n\nFurther helpful VSCode extensions:\n\n- [Vue.js Extension Pack](https://marketplace.visualstudio.com/items?itemName=mubaidr.vuejs-extension-pack)\n- [Vue 3 Snippets](https://marketplace.visualstudio.com/items?itemName=hollowtree.vue-snippets)\n- [Peacock](https://marketplace.visualstudio.com/items?itemName=johnpapa.vscode-peacock)\n\n📑 Note: The VSCode `settings.json` is pushed to git. In order to properly use the defined formatting settings, you definitely will need the above mentioned extension.\n\n## ⚙ Project Setup\n\n### Clone the Git repository\n\n```sh\ngit clone https://github.com/tmeftah/Aora.git\n```\n\n### Setup Backend\n\n- **Navigate to the backend directory:**\n\n  ```bash\n  cd backend/\n  ```\n\n- **Create a virtual environment:**\n\n  ```bash\n  python -m venv venv\n  ```\n\n- **Activate the virtual environment:**\n\n  - On Windows:\n    ```bash\n    venv\\Scripts\\activate\n    ```\n  - On macOS/Linux:\n    ```bash\n    source venv/bin/activate\n    ```\n\n- **Install all required packages:**\n\n  ```bash\n  pip install -r requirements.txt\n  ```\n\n- **Run the development server:**\n\n  ```bash\n  fastapi dev\n  ```\n\n### Setup Frontend\n\n- **Navigate to the frontend directory:**\n\n  ```bash\n  cd frontend\n  ```\n\n- **Install all necessary packages:**\n\n  ```bash\n  npm install\n  ```\n\n- **Run the development server:**\n\n  ```bash\n  npm run dev\n  ```\n\n#### Create Embeddings\n\nTo create a vector datastore of your documents, you need follow this steps:\n\n1.  Inside the **'backend/'** folder create folder named 'docs' and add you pdf documents.\n2.  run following command\n\n```bash\ncd backend\n```\n\nNow run the create_embeddings file to create embeddings.\n\n```bash\npython create_embeddings.py # create embeddings.\n```\n\n## 📚 Configuration Settings\n\n### Backend Environment Configuration\n\n- Create an `.env` file inside the `backend` folder with the following settings:\n\n  ```env\n  LLM_API_KEY = \"\u003cAPI_KEY\u003e\"\n  LLM_API_BASE_URL = \"\u003cBASE_URL\u003e\"\n\n  ```\n\n### Frontend Environment Configuration\n\n- Create an `.env` file inside the `frontend` folder with the following settings for the UI:\n\n  ```env\n  API=http://ip-address-of-api:port\n  ```\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contact\n\nThis project is a part of the GenAI project.\nIn case there are any questions, please contact Nikhil Raikar or Tarek Meftah\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmeftah%2Faora","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmeftah%2Faora","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmeftah%2Faora/lists"}