{"id":22809035,"url":"https://github.com/ccuffs/aura","last_synced_at":"2025-07-21T03:34:31.098Z","repository":{"id":54145539,"uuid":"329907330","full_name":"ccuffs/aura","owner":"ccuffs","description":"Assistente virtual do curso de Ciência da Computação da Universidade Federal da Fronteira Sul, campus Chapecó.","archived":false,"fork":false,"pushed_at":"2021-08-02T13:38:33.000Z","size":953,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-22T13:54:07.958Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/ccuffs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-15T12:34:35.000Z","updated_at":"2022-01-30T11:50:23.000Z","dependencies_parsed_at":"2022-08-13T07:31:25.386Z","dependency_job_id":null,"html_url":"https://github.com/ccuffs/aura","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"ccuffs/template","purl":"pkg:github/ccuffs/aura","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Faura","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Faura/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Faura/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Faura/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ccuffs","download_url":"https://codeload.github.com/ccuffs/aura/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Faura/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266235559,"owners_count":23897181,"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":"2024-12-12T11:13:18.081Z","updated_at":"2025-07-21T03:34:31.078Z","avatar_url":"https://github.com/ccuffs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"800\" src=\".github/logo.png\" title=\"Logo do projeto\"\u003e\u003cbr /\u003e\n    \u003cimg src=\"https://img.shields.io/maintenance/yes/2021?style=for-the-badge\" title=\"Status do projeto\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/workflow/status/ccuffs/template/ci.uffs.cc?label=Build\u0026logo=github\u0026logoColor=white\u0026style=for-the-badge\" title=\"Status do build\"\u003e\n\u003c/p\u003e\n\n# Aura\n\nA assiste virtual do curso de [Ciência da Computação][https://cc.uffs.edu.br] da [Universidade Federal da Fronteira Sul (UFFS)](https://www.uffs.edu.br), cujo objetivo é facilitar o acesso à informação por parte da comunidade acadêmica. Para isto ela utiliza técnicas de Inteligência Artifial que permitem que as informações corretas sejam fornecidas àqueles que as buscam. \n\nA Aura pode ser muito mais rápida que uma pessoa, trabalha 24h por dia, sete dias por semana para solucionar seus problemas. \n\n\u003e **IMPORTANTE:** A Aura está em fase de desenvolvimento, portanto seus resultados de busca podem não ser satisfatórios - nada substitui um e-mail cuidadosamente escrito por uma pessoa :)\n\n## 🚀 Começando\n\n### 1. Dependências\n\nPara executar o projeto, você precisa ter o seguinte instalado:\n\n- [Git](https://git-scm.com);\n- [PHP](https://www.php.net/downloads);\n- [Composer](https://getcomposer.org/download/);\n- [NodeJS](https://nodejs.org/en/);\n- [NPM](https://www.npmjs.com/package/npm);\n\nVocê precisa de várias extensões PHP instaladas também:\n\n```\nsudo apt install php-cli php-mbstring php-zip php-xml php-curl\n```\n\n### 2. Configuração\n\nFeito a instalação das dependências, é necessário obter uma cópia do projeto. A forma recomendada é clonar o repositório para a sua máquina.\n\nPara isso, rode:\n\n```\ngit clone --recurse-submodules https://github.com/ccuffs/aura \u0026\u0026 cd aura\n```\n\nIsso criará e trocará para a pasta `aura` com o código do projeto.\n\n#### 2.1 PHP\n\nInstale as dependências do PHP usando o comando abaixo:\n\n```\ncomposer install\n```\n\n#### 2.2 Banco de Dados\n\nO banco de dados mais simples para uso é o SQLite. Para criar uma base usando esse SGBD, rode:\n\n```\ntouch database/database.sqlite\n```\n\n#### 2.3 Node\n\nInstale também as dependências do NodeJS executando:\n\n```\nnpm install\n```\n\n#### 2.4 Laravel\n\nCrie o arquivo `.env` a partir do arquivo `.env.example` gerado automaticamente pelo Laravel:\n\n```\ncp .env.example .env\n```\n\nCrie as tabelas do banco de dados:\n\n```\nphp artisan migrate\n```\n\nPor fim execute o comando abaixo para a geração da chave de autenticação da aplicação:\n\n```\nphp artisan key:generate\n```\n\nGere os recursos JavaScript e CSS:\n\n```\nnpm run dev\n```\n\n\u003e*DICA:* enquanto estiver desenvolvendo, rode `npm run watch` para manter os scripts javascript sendo gerados sob demanda quando alterados.\n\n### 3. Utilizacão\n\n#### 3.1 Rodando o projeto\n\nDepois de seguir todos os passos de instalação, inicie o servidor do Laravel:\n\n```\nphp artisan serve\n```\n\nApós isso a aplicação estará rodando na porta 8000 e poderá ser acessada em [localhost:8000](http://localhost:8000).\n\n\n#### 3.2 Utilização da API\n\nSe você utilizar a API dessa aplicacão, todos endpoints estarão acessivel em `/api`, por exemplo [localhost:8000/api](http://localhost:8000/api). Os endpoints que precisam de uma chave de autenticação devem ser utilizar o seguinte cabeçalho HTTP:\n\n```\nAuthorization: Bearer XXX\n```\n\nonde `XXX` é o valor da sua chave de acesso (api token do Jetstream), por exemplo `c08cbbfd6eefc83ac6d23c4c791277e4`.\nAbaixo está um exemplo de requisição para o endpoint `user` utilizando a chave de acesso acima:\n\n```bash\ncurl -H 'Accept: application/json' -H \"Authorization: Bearer c08cbbfd6eefc83ac6d23c4c791277e4\" http://localhost:8080/api/user\n```\n\n## 🤝 Contribua\n\nSua ajuda é muito bem-vinda, independente da forma! Confira o arquivo [CONTRIBUTING.md](CONTRIBUTING.md) para conhecer todas as formas de contribuir com o projeto. Por exemplo, [sugerir uma nova funcionalidade](https://github.com/ccuffs/aura/issues/new?assignees=\u0026labels=\u0026template=feature_request.md\u0026title=), [reportar um problema/bug](https://github.com/ccuffs/aura/issues/new?assignees=\u0026labels=bug\u0026template=bug_report.md\u0026title=), [enviar um pull request](https://github.com/ccuffs/hacktoberfest/blob/master/docs/tutorial-pull-request.md), ou simplemente utilizar o projeto e comentar sua experiência.\n\nVeja o arquivo [ROADMAP.md](ROADMAP.md) para ter uma ideia de como o projeto deve evoluir.\n\n\n## 🎫 Licença\n\nEsse projeto é licenciado nos termos da licença open-source [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) e está disponível de graça.\n\n## 🧬 Changelog\n\nVeja todas as alterações desse projeto no arquivo [CHANGELOG.md](CHANGELOG.md).\n\n## 🧪 Projetos semelhates\n\nAbaixo está uma lista de links interessantes e projetos similares:\n\n* [Home Assistant](https://github.com/home-assistant/core)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccuffs%2Faura","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccuffs%2Faura","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccuffs%2Faura/lists"}