My School

Sobre

My School é um simples projeto de gerenciamento de usuários feito com o intuito de aplicar ferramentas que tenho estudado recentemente. Nele é possível ver na prática a utilização da stack ReactJS, NextJS e styled-components; material-ui e react-hook-form além de várias outras APIs bastante úteis no desenvolvimento deste tipo de software. Por ser uma aplicação de estudos, não há intenção em disponibilizá-la como produto ou publicá-la para uso em produção. Caso considere alguma parte do código interessante ou acredite que algo possa ser melhorado, fique à vontade para comentar. Todo feedback é bem-vindo.

Front-end

Para facilitar a manutenção e separar as responsabilidades da aplicação, o front-end encontra-se neste repositório.

Layout

Exemplo do design adotado para páginas públicas.

Definições

O projeto foi dividido em 4 partes separadas por níveis de usuário da seguinte maneira:

Visitante - Esse é o nível mais básico de acesso. Usuários com esse perfil ainda não criaram uma conta ou ainda não estão logados na plataforma. Dessa maneira, é possível acessar a página inicial, a lista de cursos, os detalhes de cada curso, a página de criação de perfil e o login;
Aluno - Esse é o nível mais básico de acesso logado. Usuários com esse perfil, além de poderem fazer tudo o que um visitante faz, podem se cadastrar nos cursos que desejarem, acompanhar seu dashboard de acessos, atualizar seu perfil e posteriormente poderão assistir às aulas cadastradas na plataforma;
Professor - Esse é um nível especial de acesso logado. Professores só podem ser cadastrados na plataforma por administradores. Além de todas as funcionalidades presentes no nível de acesso dos alunos, professores posteriormente poderão cadastrar aulas na plataforma e apontar as notas dos alunos;
Administrador - Esse é o nível de maior privilégio logado. Administradores podem incluir, alterar, atualizar e excluir cursos; incluir ou atualizar acessos de professores e outros administradores; aprovar ou excluir matrículas em determinados cursos. Entretanto, administradores não podem estar matriculados em curso algum.

Além disso, foi implantado um workflow de aprovação de matrícula mediante validação da administração. Nesse fluxo, um aluno ou professor se cadastra no curso escolhido e entra em uma fila, podendo iniciar o seu curso somente após a atualização do pedido, feita somente por um administrador.

Tecnologias

Como mencionado, este é um projeto de estudos e tem como premissa o aprendizado e a apresentação de tecnologias, frameworks e ferramentas de desenvolvimento. Segue a lista das principais libs utilizadas:

NodeJS - Servidor principal;
Express - Um framework web para Node.js;
Express Validator - Middleware para validação de rotas;
TypeScript - Uma extensão do JavaScript;
Helmet - Conjunto de validações de segurança para apps express;
TypeORM - Um dos ORMs mais populares para JavaScript e TypeScript;
PostgreSQL - Um dos bancos de dados relacionais mais populares do mundo;
jsonwebtoken - Biblioteca para transmissão segura de JWTs;

Como executar o projeto localmente

Certifique-se que você tenha instalado em sua máquina o Git, o NodeJS e o PostgreSQL. Em seguida, execute os seguintes passos:

# Clone este repositório
$ git clone https://github.com/rodrigolemos/my-school

# Acesse a pasta do projeto
$ cd my-school

# Instale as dependências
$ npm install

# Inclua no arquivo ormconfig.js suas configurações de banco de dados

# Rode as migrations para criação das tabelas
$ npx typeorm migration:run

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

Após esses passos, aplicação estará disponível na porta 3000 - http://localhost:3000.

Autor

Rodrigo Lemos