Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iagolirapasssos/classportal
O ClassPortal é uma plataforma simples para gerenciamento de salas de aula online. Ele permite que mestres (professores) criem salas de aula virtuais onde os alunos podem postar conteúdos. O sistema inclui funcionalidade para criação de salas, controle do conteúdo postado e gerenciamento de usuários.
https://github.com/iagolirapasssos/classportal
alunos aula escola escolar gerenciamento portal sala
Last synced: 5 days ago
JSON representation
O ClassPortal é uma plataforma simples para gerenciamento de salas de aula online. Ele permite que mestres (professores) criem salas de aula virtuais onde os alunos podem postar conteúdos. O sistema inclui funcionalidade para criação de salas, controle do conteúdo postado e gerenciamento de usuários.
- Host: GitHub
- URL: https://github.com/iagolirapasssos/classportal
- Owner: iagolirapasssos
- License: other
- Created: 2024-08-20T20:42:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T18:44:26.000Z (3 months ago)
- Last Synced: 2024-08-26T21:57:48.502Z (3 months ago)
- Topics: alunos, aula, escola, escolar, gerenciamento, portal, sala
- Language: JavaScript
- Homepage: https://iagolirapasssos.github.io/ClassPortal/
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ClassPortal
O **ClassPortal** é uma plataforma simples para gerenciamento de salas de aula online. Ele permite que mestres (professores) criem salas de aula virtuais onde os alunos podem postar conteúdos. O sistema inclui funcionalidade para criação de salas, controle do conteúdo postado e gerenciamento de usuários.
## Estrutura do Projeto
O projeto possui a seguinte estrutura de diretórios e arquivos:
```
ClassPortal:
├─── generateCode.js # Script para gerar códigos únicos para salas
├─── LICENSE # Licença do projeto
├─── package.json # Configurações do projeto e dependências
├─── public # Arquivos públicos para a interface do usuário
│ ├── index.html # Página inicial para login e registro de salas
│ ├── master.html # Página de controle para o mestre
│ ├── room.html # Página de visualização e interação nas salas
│ ├── script.js # Script de interação com a interface
│ └── styles.css # Estilos da interface
├─── README.md # Documentação do projeto
└─── server.js # Servidor Node.js responsável pela lógica de back-end
```
## Funcionalidades
- **Login e Criação de Salas**: O sistema permite que o usuário crie salas e faça login como mestre ou aluno.
- **Controle do Mestre**: O mestre da sala tem controle sobre o conteúdo postado, com opções para edição e exclusão de postagens.
- **Postagens de Alunos**: Alunos podem fazer postagens nas salas, que serão exibidas em tempo real para o mestre e outros participantes.
- **Gerenciamento de Conteúdo**: As postagens nas salas são armazenadas e organizadas em arquivos JSON.
## Instalação e Execução
### Requisitos
- [Node.js](https://nodejs.org/) 18 ou superior instalado na máquina.
- [npm](https://www.npmjs.com/) (ou [yarn](https://yarnpkg.com/)) para gerenciamento de pacotes.
### Instalação do Node.js 18 ou Superior
#### No Linux
1. **Atualize o índice de pacotes:**
```bash
sudo apt update
```
2. **Instale as dependências necessárias:**
```bash
sudo apt install curl
```
3. **Baixe e execute o instalador de Node.js:**
```bash
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
```
4. **Instale o Node.js e npm:**
```bash
sudo apt install -y nodejs
```
5. **Verifique a instalação:**
```bash
node -v
npm -v
```
#### No Windows
1. **Baixe o instalador do Node.js** para Windows a partir do site oficial: [Node.js Downloads](https://nodejs.org/en/download/).
2. **Execute o instalador** e siga as instruções na tela. Certifique-se de selecionar a opção para instalar o npm durante o processo.
3. **Verifique a instalação** abrindo o Prompt de Comando e executando:
```cmd
node -v
npm -v
```
#### No macOS
1. **Use o Homebrew para instalar o Node.js:** Se você não tiver o Homebrew instalado, você pode instalá-lo a partir do site oficial: [Homebrew](https://brew.sh/).
2. **Instale o Node.js com Homebrew:**
```bash
brew install node@18
```
3. **Crie um link simbólico para o Node.js:**
```bash
brew link --force --overwrite node@18
```
4. **Verifique a instalação:**
```bash
node -v
npm -v
```
### Passos de Instalação
1. Clone o repositório:
```bash
git clone https://github.com/seu-usuario/classportal.git
cd classportal
```
2. Instale as dependências:
```bash
npm install
```
3. Inicie o servidor:
```bash
node server.js
```
4. Acesse a aplicação:
Abra o navegador e vá para `http://localhost:3000`.
### Utilização
1. **Criação de Salas**:
- Ao acessar `index.html`, você pode criar uma nova sala ou se juntar a uma sala existente inserindo o código da sala.
2. **Página do Mestre**:
- Após criar uma sala, o mestre é redirecionado para a página `master.html`, onde pode ver e controlar as postagens de todos os usuários na sala.
3. **Postagens nas Salas**:
- Usuários podem acessar as salas através de `room.html` e interagir postando conteúdos. O mestre pode editar ou remover postagens se necessário.
### Funcionalidade de IP
Este projeto utiliza o `os` module para capturar o endereço IP do usuário que cria a sala. Esse IP é usado para controlar permissões e gerenciamento de conteúdo.
### Nota sobre Hospedagem
Se você estiver hospedando o projeto em um ambiente estático como GitHub Pages, lembre-se de que o projeto depende de um servidor back-end para capturar IPs e gerenciar as salas. Portanto, recomenda-se usar uma plataforma de hospedagem que suporte Node.js, como Heroku, Vercel ou DigitalOcean.
## Licença
Este projeto está licenciado sob a licença Attribution-NonCommercial-NoDerivatives 4.0 International - veja o arquivo [LICENSE](LICENSE) para mais detalhes.
---
Este README fornece uma visão geral e as instruções básicas para executar o projeto localmente.