Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josejefferson/cranio
Mural de avisos eletrônico + Jogo de perguntas
https://github.com/josejefferson/cranio
game noticeboard school trivia
Last synced: 12 days ago
JSON representation
Mural de avisos eletrônico + Jogo de perguntas
- Host: GitHub
- URL: https://github.com/josejefferson/cranio
- Owner: josejefferson
- Created: 2022-04-28T20:49:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T12:48:44.000Z (about 1 year ago)
- Last Synced: 2024-05-28T16:28:57.530Z (8 months ago)
- Topics: game, noticeboard, school, trivia
- Language: TypeScript
- Homepage: https://cranio-dev.vercel.app
- Size: 16.6 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💀 O Crânio
O "Crânio" é um sistema de mural de avisos eletrônicos desenvolvido especificamente para o IFPB. Além de servir como um mural informativo, o Crânio oferece aos alunos a oportunidade de participar de um jogo de perguntas integrado, onde podem responder às questões e, a critério do professor, ter a chance de ganhar recompensas.
Este projeto foi concebido por um professor do campus com a ideia de executá-lo em uma Raspberry Pi, conectada a um monitor e um teclado numérico. Isso permite que os alunos visualizem os avisos no mural e interajam facilmente com o jogo de perguntas. Quando um aluno responde a uma pergunta corretamente, o sistema envia automaticamente um e-mail ao professor notificando-o da resposta correta.
## 👨💻 Autores
- [@josejefferson](https://github.com/josejefferson)
- [@KayoRonald](https://github.com/KayoRonald)
## 💿 Tecnologias utilizadas
## 🔑 Variáveis de Ambiente
Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu **.env**
`MONGO_DB` - _Connection string_ do MongoDB
`GMAIL_CLIENT_ID`, `GMAIL_CLIENT_SECRET`, `GMAIL_EMAIL`, `GMAIL_REFRESH_TOKEN` - Credenciais do Gmail
## 🚀 Rodando localmente
#### Clone o projeto
```bash
git clone https://github.com/josejefferson/cranio
```
#### Entre no diretório do projeto
```bash
cd cranio
```
#### Instale as dependências
```bash
yarn
```
#### Faça o build
```bash
yarn build
```
#### Inicie o servidor
```bash
yarn start
```
## 📷 Screenshots
### Tela inicial, onde passam anúncios
### Ao pressionar qualquer tecla, aparece a tela para digitar a matrícula do aluno
### Após digitar a matrícula, inicia-se o desafio, se o aluno acertar a pergunta, um e-mail será enviado ao professor que criou a pergunta
### Administração / Editando desafio
### Administração / Editando anúncio
## 📖 Documentação da API
> **Note**
> Algumas chamadas de API podem requerer um cabeçalho de autenticação!
#### Retorna todos os anúncios ativos
```http
GET /highlights/active
```
#### Retorna um desafio para um determinado estudante
```http
GET /challenges/start/:registration
```
| Parâmetro | Tipo | Descrição |
| :------------- | :------- | :-------------------------------------- |
| `registration` | `string` | **Obrigatório**. Matrícula do estudante |
#### Verifica se a resposta está correta
```http
POST /challenges/check
```
| Parâmetro | Tipo | Descrição |
| :-------------------- | :------- | :------------------------------------------- |
| `studentRegistration` | `string` | **Obrigatório**. Matrícula do estudante |
| `challengeID` | `string` | **Obrigatório**. ID do desafio |
| `choiceID` | `string` | **Obrigatório**. ID da alternativa escolhida |
#### Retorna os dados de um estudante
```http
GET /students/find/:registration
```
| Parâmetro | Tipo | Descrição |
| :------------- | :------- | :-------------------------------------- |
| `registration` | `string` | **Obrigatório**. Matrícula do estudante |
## 🗨 Feedback
Se você tiver algum feedback, por favor nos deixe saber por meio do [formulário](https://forms.gle/3XdA6TizDNp8yosu9).