API Escola Organizada

Este é um projeto pessoal, que será integrado com o projeto Escola Organizada

A função desta API é guardar e gerenciar informações sobre a vida acadêmica dos estudantes de qualquer escola de ensino regular. Está API conecta-se a um banco de dados Postgress 🐘, sendo possível criar, ler, atualizar e deletar informações do dado de dados.

Está api está hospedada na cyclic, caso queria dar uma olhada acesse Porém se você quiser vem ela em ação acesse o projeto Escola Organizada para ter acesso a um usuário, me chama no LinkedIn linkedIn.

🔎 Acessando as informações da API

Todas as rotas são protegidas, sendo assim, é necessário fazer login para ter acesso a API, os acessos são divididos em três tipo:
- Admin "este usuário têm acesso a todas as rotas do projeto e tem permições para ler, criar, atualizar e deletar informações do banco de dados"
- Teacher "Este usuário pode atualizar informações dos alunos, como notas e frequência, por exemplo"
- Responsible "Este usuário por sua vez, tem permissão apenas de ver as informações dos filhos

💻 tecnologias / bibliotecas :

Node JS

React Router DOM

Postgress

Sequelize

YUP : validações de dados

Token JWT

Yarn

Hospedagem : Heroku

Estrutura de pastas : MVC

Docker (localmente)

Gitflow

Padronização de códigos : prettier e eslint

📋 Pré-requisitos

Você precisará ter o node e o git instalados na sua máquina

🔧 Usando na sua máquina
Abra o git bash em uma pasta da sua escolha e execute o comando:
git clone https://github.com/Alexandresfi/api-escola-organizada.git

Em seguida vá para a pasta /src e abra o terminal e execute:

yarn

para instalar as dependências, logo em seguida execute o comando:

yarn dev

para rodar a aplicações.

É importante que você tenha algum aplicativo no seu notebook para fazer as consultas, como por exempplo o postman ou o Insommia Tendo um desses aplicativos, basta ir na basta /src/routes.js e usar umas das rotas.

>importante: Você não vai conseguir acessar as rodas do projeto, sem ter uma conta, e para abrir uma, entre em contato comigo pelo linkedIn