Assistente Virtual BoardClass

Desenvolvido para API (Aprendizagem por Projeto Integrador) da Fatec São José dos Campos - Banco de Dados

A assistente BoardClass é uma assistente virtual web. Seu objetivo é auxiliar professores com o gerenciamento de turmas, alunos e disciplinas: permitindo a criação de novas turmas/disciplinas, agendamento de provas, adição de novos alunos, entre outras funcionalidades.

Ela funciona recebendo o comando por voz (por meio do professor) e realizando em seguida o que foi pedido. Em alguns casos, é necessário que o professor dê o comando por voz e então tenha que inserir manualmente os dados para que a ação seja concluída. Por exemplo na criação de um aluno, ele deve inserir as informações do aluno por meio do teclado do próprio computador.

🙅‍♂️ Equipe

Equipe Vox

Integrantes: João Vitor Marques, Luciano Pamplona, Silas Rafael

👨‍💻 Tecnologias

Este projeto foi desenvolvido com as seguintes tecnologias, e aplicações:

Design: Figma
Ecossistema: Node.js
Front End: React
Back End: AdonisJS
Banco de dados: PostgreSQL

🕛 Cronograma

Sprint 1: 25/03 - 14/04

Sprint 2: 25/04 - 15/05

Sprint 3: 16/05 - 05/06

📃 Backlog do produto

📄 Sprint backlog

Sprint Backlog 1
Sprint Backlog 2
Sprint Backlog 3

📝 Task/Story Board

ℹ️ Como usar o aplicativo

Pré-requisitos

Para clonar e rodar a aplicação, é necessário ter instalado em sua máquina as ferramentas: Git, Node.js e Yarn (opcional). Além disso, é legal ter um bom editor de código, como o VSCode

🎲 Rodando a aplicação

# --backend
# Clone este repositório
$ git clone <https://github.com/joaovtmarques/assistente_virtual_boardclass>
# Acesse a pasta do projeto no terminal
$ cd assistente_virtual_boardclass
# Navegue até a pasta 'backend' e depois até a pasta 'boardclass'
$ cd backend
$ cd boardclass
# Instale as dependências
$ npm install ou yarn install
# Configure o orm do adonisjs para banco de dados PostgreSQL
$ node ace configure @adonisjs/lucid
# Na raíz do projeto, crie um arquivo .env com as mesmas variáveis contidas em .env.example
# Preencha as variáveis com os respectivos valores da sua máquina
# Execute a aplicação
$ node ace serve ou yarn dev

# --frontend
# Clone este repositório
$ git clone <https://github.com/joaovtmarques/assistente_virtual_boardclass>
# Acesse a pasta do projeto no terminal
$ cd assistente_virtual_boardclass
# Navegue até a pasta 'frontend' e depois até a pasta 'boardclass'
$ cd frontend
$ cd boardclass
# Instale as dependências
$ npm install ou yarn install
# Na raíz do projeto, crie um arquivo .env com a variável contida em .env.example
$ REACT_APP_BACKEND_URL=http://{ip-backend}:{porta}/api
# Preencha a variável com o ip do backend rodando na sua máquina
# Com o backend já em execução:
# Execute a aplicação
$ npm start ou yarn start

joaovtmarques / assistente_virtual_boardclass Goto Github PK