Introdução

A Sala dos Gênios é uma plataforma que serve para acompanhar os assuntos a serem aprendidos e debatidos em uma aula ao vivo, onde o professor pode lançar perguntas em tempo real sobre os assuntos e acompanhar o resultado dos alunos, com o objetivo de mantê-los sempre focados.

Caso queira dar sugestões, críticas construtivas e reportar problemas, ficaria muito grato! 😁

Conteúdo

• Instalação
• Codebase Overview
• Tech Stack

Instalação

Para executar o projeto em sua máquina, você deverá ter o node e o npm instalado globalmente.

Eu utilizei a versão 16.6.1 do node.

Passo 1

Faça um clone do projeto e instale as dependências em ambos os diretórios (frontend e backend):

Com npm:

git clone https://github.com/JosueFS/classroom-app.git
cd classroom-app/frontend && npm install
cd classroom-app/backend && npm install

Ou com yarn:

git clone https://github.com/JosueFS/classroom-app.git
cd classroom-app/frontend && yarn
cd classroom-app/backend && yarn

Passo 2

Crie um database no mongoDB Atlas ou algum outro de sua preferência e um conta de acesso, após isso você poderá obter as variáveis de ambiente para utilizar nos arquivos .env:

# backend\.env
PORT=3333
MONGODB_URL=mongodb+srv://...
MONGODB_DBNAME=classroom-app

# frontend\.env

REACT_APP_SERVER_URL=http://localhost:3333

Passo 3

Inicie um servidor de desenvolvimento:

cd frontend && npm start || cd frontend && yarn start
cd backend && npm dev || cd backend && yarn dev

Algumas telas da aplicação

Como contribuir?

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

   Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

🦸 Autor

---

📝 Licença

Este projeto esta sobe a licença MIT.

Entre em contato!