https://github.com/ccuffs/aura
Assistente virtual do curso de Ciência da Computação da Universidade Federal da Fronteira Sul, campus Chapecó.
https://github.com/ccuffs/aura
Last synced: 12 months ago
JSON representation
Assistente virtual do curso de Ciência da Computação da Universidade Federal da Fronteira Sul, campus Chapecó.
- Host: GitHub
- URL: https://github.com/ccuffs/aura
- Owner: ccuffs
- License: mit
- Created: 2021-01-15T12:34:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T13:38:33.000Z (almost 5 years ago)
- Last Synced: 2025-04-22T13:54:07.958Z (about 1 year ago)
- Language: PHP
- Size: 931 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# Aura
A 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.
A Aura pode ser muito mais rápida que uma pessoa, trabalha 24h por dia, sete dias por semana para solucionar seus problemas.
> **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 :)
## 🚀 Começando
### 1. Dependências
Para executar o projeto, você precisa ter o seguinte instalado:
- [Git](https://git-scm.com);
- [PHP](https://www.php.net/downloads);
- [Composer](https://getcomposer.org/download/);
- [NodeJS](https://nodejs.org/en/);
- [NPM](https://www.npmjs.com/package/npm);
Você precisa de várias extensões PHP instaladas também:
```
sudo apt install php-cli php-mbstring php-zip php-xml php-curl
```
### 2. Configuração
Feito 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.
Para isso, rode:
```
git clone --recurse-submodules https://github.com/ccuffs/aura && cd aura
```
Isso criará e trocará para a pasta `aura` com o código do projeto.
#### 2.1 PHP
Instale as dependências do PHP usando o comando abaixo:
```
composer install
```
#### 2.2 Banco de Dados
O banco de dados mais simples para uso é o SQLite. Para criar uma base usando esse SGBD, rode:
```
touch database/database.sqlite
```
#### 2.3 Node
Instale também as dependências do NodeJS executando:
```
npm install
```
#### 2.4 Laravel
Crie o arquivo `.env` a partir do arquivo `.env.example` gerado automaticamente pelo Laravel:
```
cp .env.example .env
```
Crie as tabelas do banco de dados:
```
php artisan migrate
```
Por fim execute o comando abaixo para a geração da chave de autenticação da aplicação:
```
php artisan key:generate
```
Gere os recursos JavaScript e CSS:
```
npm run dev
```
>*DICA:* enquanto estiver desenvolvendo, rode `npm run watch` para manter os scripts javascript sendo gerados sob demanda quando alterados.
### 3. Utilizacão
#### 3.1 Rodando o projeto
Depois de seguir todos os passos de instalação, inicie o servidor do Laravel:
```
php artisan serve
```
Após isso a aplicação estará rodando na porta 8000 e poderá ser acessada em [localhost:8000](http://localhost:8000).
#### 3.2 Utilização da API
Se 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:
```
Authorization: Bearer XXX
```
onde `XXX` é o valor da sua chave de acesso (api token do Jetstream), por exemplo `c08cbbfd6eefc83ac6d23c4c791277e4`.
Abaixo está um exemplo de requisição para o endpoint `user` utilizando a chave de acesso acima:
```bash
curl -H 'Accept: application/json' -H "Authorization: Bearer c08cbbfd6eefc83ac6d23c4c791277e4" http://localhost:8080/api/user
```
## 🤝 Contribua
Sua 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=&labels=&template=feature_request.md&title=), [reportar um problema/bug](https://github.com/ccuffs/aura/issues/new?assignees=&labels=bug&template=bug_report.md&title=), [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.
Veja o arquivo [ROADMAP.md](ROADMAP.md) para ter uma ideia de como o projeto deve evoluir.
## 🎫 Licença
Esse 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.
## 🧬 Changelog
Veja todas as alterações desse projeto no arquivo [CHANGELOG.md](CHANGELOG.md).
## 🧪 Projetos semelhates
Abaixo está uma lista de links interessantes e projetos similares:
* [Home Assistant](https://github.com/home-assistant/core)