https://github.com/amavlopes/professor-allocation-api
A API Alocação de professores tem como objetivo otimizar o processo de alocação, permitindo a gestão de docentes de um departamento para lecionar em diferentes dias e horários para um curso específico. Desenvolvimento em Typescript para Node.js(Express), integração ao MySQL com o ORM Prisma, uso da arquitetura em camadas e injeção de dependências.
https://github.com/amavlopes/professor-allocation-api
dependency-injection express-js layered-architecture node-js prisma-orm swagger-autogen swagger-ui-express tsyringe typescript
Last synced: 15 days ago
JSON representation
A API Alocação de professores tem como objetivo otimizar o processo de alocação, permitindo a gestão de docentes de um departamento para lecionar em diferentes dias e horários para um curso específico. Desenvolvimento em Typescript para Node.js(Express), integração ao MySQL com o ORM Prisma, uso da arquitetura em camadas e injeção de dependências.
- Host: GitHub
- URL: https://github.com/amavlopes/professor-allocation-api
- Owner: amavlopes
- Created: 2025-05-07T09:18:31.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2025-05-07T09:26:50.000Z (16 days ago)
- Last Synced: 2025-05-07T10:35:30.276Z (16 days ago)
- Topics: dependency-injection, express-js, layered-architecture, node-js, prisma-orm, swagger-autogen, swagger-ui-express, tsyringe, typescript
- Language: TypeScript
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎓 API REST Alocação de Professores
Projeto para validar conceitos referente ao desenvolvimento back-end, proposto pelo professor Tiago Santos da disciplina de **Arquitetura de Software Back-End** da Pós-Graduação de **Engenharia de Software 2024.1** do Centro Universitário Frassinetti do Recife (**UniFAFIRE**).
A API Alocação de professores tem como objetivo otimizar o processo de alocação, permitindo a gestão de docentes de um departamento para lecionar em diferentes dias e horários para um curso específico. Desenvolvimento em Typescript para Node.js(Express.js), integração ao MySQL com o ORM Prisma, uso da arquitetura em camadas e injeção de dependências.
---
## 📌 Funcionalidades
- ✅ Gestão de **Cursos**
- ✅ Gestão de **Departamentos**
- ✅ Gestão de **Professores**
- ✅ Gestão de **Alocações**
---
## 🧱 Tecnologias Utilizadas
- **Node.js**
- **Express.js**
- **Typescript**
- **ORM Prisma**
- **Swagger / OpenAPI 3 (swagger-autogen)**
---
## 🚀 Como executar o projeto
#### 1. Clone o projeto
```bash
git clone https://github.com/amavlopes/professor-allocation-api.git
```
#### 2. Entre no diretório do projeto
```bash
cd professor-allocation-api
```
#### 3. Instale todas as dependências
```bash
npm install
```
#### 4. Crie um arquivo .env na raiz do projeto e preencha com as informações necessárias
##### Obs.: Utilize o arquivo .env-example como template
```bash
APP_PORT = 7000
# Listar todas as urls permitidas separadas por vírgula
ENABLED_CORS = http://localhost:7000,http://localhost:7070
# Dados para a conexão com o banco de dados
# mysql://:@:/
DATABASE_URL="mysql://user:111111@localhost:3306/professor-allocation"
```
#### 5. Crie o banco de dados executando o comando
```bash
npm run prisma-create-db
```
##### 6. (Opcional) Para popular o banco de dados execute o comando
```bash
npm run prisma-seed
```
#### 7. Inicie o servidor
```bash
npm run start
```
---
## 📚 Documentação do Swagger
```bash
http://localhost:7000/docs
```
---
⌨️ com ❤️ por [Amanda Avelino](https://github.com/amavlopes) 😊