SigmaJS

Sobre 📰

Este é um projeto desenvolvido pelos alunos Joaquim Lagos, Filipe Dias, Felipe Brückmann e Jardel Urban para o Projeto Integrador do 3° semestre de Análise e desenvolvimento de sistemas da faculdade SENAI florianópolis.

O objetivo desta aplicação é desenvolver um conjunto de funcionalidades para um jogo educacional para ensino da matemática no ensino fundamental I baseado em perguntas e respostas.

---

Requisitos do Projeto ✔️

• Jogo desenvolvido como uma aplicação Web
• Implementação do backend com JavaScript, Node.js, Express
• Implementação do frontend com HTML, CSS, JavaScript e React
• Backend implementado como Web Service RESTful
• Frontend integrado com o backend e comunicando utilizando JSON
• Integração com banco de dados relacional (Postgres ou MySQL)
• Autenticação e autorização com JWT
• Restrição de acesso a todas as páginas da aplicação apenas para usuários autenticados, exceto ao formulário de autenticação
• Cada partida deve consistir de uma sequência de 10 perguntas de múltipla
• escolha e registrar a pontuação do usuário
• Apenas uma pergunta deve ser exibida de cada vez para o usuário
• Para avançar para a próxima pergunta, o usuário deve responder a pergunta atual
• Após a 10ª pergunta, a aplicação deve exibir a pontuação do usuário
• A página inicial deve exibir um ranking dos jogadores por pontuação
• Definir uma estrutura em memória para dar suporte para o armazenamento das perguntas, com espaço para armazenamento das respostas e pontuação obtida na pergunta.
• Definir uma estrutura em memória para armazenar o ranking dos jogadores, permitindo ordenação por nome ou por pontuação - a ordenação deve ser uma função criada pela equipe, não pode usar API.

---

Tecnologias utilizadas 💻

• NodeJS
• Express
• ReactJS
• Postgresql
• Knex
• JWT
• Sucrase
• Winston
• Dotenv
• Cors
• ChakraUI
• Axios

# Ferramentas de desenvolvimento :wrench:

• Nodemon
• Postman
• Insomnia
• PgAdmin

---

Como baixar e executar o projeto 💡

BACK-END 🔚

# Primeiramente clone o repositorio
$ git clone https://github.com/Lipzs/SigmaJS.git

# Mova se para a pasta do back-end
$ cd SigmaJS/server

# Agora, instale as dependencias com o comando
$ yarn install 
# ou
$ npm install

# Agora para que a aplicação funcione você deve configurar o Banco de Dados

# Após configurar o Banco de Dados basta mover-se para /SigmaJS/server e então executar:

$ yarn start 
# ou
$ npm start

---

Banco de dados 🏦

# Para rodar a aplicação é recomendado que você tenha o postgres instalado no computador/vm
# ou utilizar o AWS RDS. Após criar o Banco de dados você deve mover-se para /SigmaJS/server
# e criar um arquivo .env

$ touch .env

# No .env você deve preencher estes dados de acordo com as credenciais do seu banco de dados:

HOST="" 
USUARIO=""
SENHA=""
DATABASE=""
SECRET='95ff082716bcccfe41b89da596b4e578'

# Host = se estiver usuando o banco postgres local deve preencher com HOST="localhost",
# se estiver utilizando AWS RDS você deverá colocar o endpoint do seu RDS
# HOST="intanciaexemplo.rds.amazonaws.com".

# Os campos USUARIO, SENHA E DATABASE você irá preencher
# com as credenciais nas quais você criou o banco de dados.

# O campo SECRET não deve ser alterado.

# Agora você deverá criar outro .env porém dentro do diretório /SigmaJS/server/src

$ touch .env

# Então deve preencher com as mesma credenciais do 1° .env

# Após configurar os arquivos .env você deverá criar as tabelas do banco de dados.
# Mova-se para /SigmaJS/server/src e então escreva os seguintes comandos:

$ npx knex migrate:latest
# e
$ npx knex seed:run

# Pronto agora o Banco de dados já está configurado.

---

FRONT-END 🎥

# Com o BACK-END e o Banco de dados já configurados, mova-se para /SigmaJS/web 
# e então instale as dependências com o seguinte comando:

$ yarn install 
# ou
$ npm install

# Agora é só rodar o comando: 

$ npm start